VMware Cloud Director API - OIDCAttributeMapping

OIDCAttributeMappingType

Element:

OIDCAttributeMapping

Type:

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Contains custom claim keys for the /userinfo endpoint

Since:

31.0

Schema:

vCloudEntities.xsd

Media type(s):

None

Extends:

ResourceType

XML Representation:

<OIDCAttributeMapping xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <SubjectAttributeName> xs:string </SubjectAttributeName>
    <EmailAttributeName> xs:string </EmailAttributeName>
    <FullNameAttributeName> xs:string </FullNameAttributeName>
    <FirstNameAttributeName> xs:string </FirstNameAttributeName>
    <LastNameAttributeName> xs:string </LastNameAttributeName>
    <GroupsAttributeName> xs:string </GroupsAttributeName>
    <RolesAttributeName> xs:string </RolesAttributeName>
</OIDCAttributeMapping>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	31.0		The URI of the entity.
type	string	No	always	31.0		The MIME type of the entity.

Elements

Element	Type	Required	Modifiable	Since	Description
EmailAttributeName	string	No	always	31.0	The name of the OIDC attribute used to get the email from the IDP's userInfo
FirstNameAttributeName	string	No	always	31.0	The name of the OIDC attribute used to get the first name from the IDP's userInfo. This is only used if the Full Name key is not specified.
FullNameAttributeName	string	No	always	31.0	The name of the OIDC attribute used to get the full name from the IDP's userInfo. The full name attribute overrides the use of the firstName and lastName attributes.
GroupsAttributeName	string	No	always	31.0	The name of the OIDC attribute used to get the user's groups from the IDP's userInfo.
LastNameAttributeName	string	No	always	31.0	The name of the OIDC attribute used to get the last name from the IDP's userInfo. This is only used if the Full Name key is not specified.
Link	LinkType	No	none	31.0	A reference to an entity or operation associated with this object.
RolesAttributeName	string	No	always	31.0	The name of the OIDC attribute used to get the user's roles from the IDP's userInfo.
SubjectAttributeName	string	No	always	31.0	The name of the OIDC attribute used to get the username from the IDP's userInfo
VCloudExtension	VCloudExtensionType	No	always	31.0	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.