VMware Cloud Director API - OrgOAuthSettings

OrgOAuthSettingsType

Element:

OrgOAuthSettings

Type:

OrgOAuthSettingsType

Namespace:

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

Description:

Contains OAuth identity provider settings for an organization.

Since:

9.0

Schema:

vCloudEntities.xsd

Media type(s):

application/vnd.vmware.admin.organizationOAuthSettings+json
application/vnd.vmware.admin.organizationOAuthSettings+xml

Extends:

ResourceType

XML Representation:

<OrgOAuthSettings 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"/>
    <OrgRedirectUri> xs:string </OrgRedirectUri>
    <IssuerId> xs:string </IssuerId>
    <OAuthKeyConfigurations 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"/>
        <OAuthKeyConfiguration 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"/>
            <KeyId> xs:string </KeyId>
            <Algorithm> xs:string </Algorithm>
            <Key> xs:string </Key>
            <ExpirationDate> xs:dateTime </ExpirationDate>
        </OAuthKeyConfiguration>
    </OAuthKeyConfigurations>
    <Enabled> xs:boolean </Enabled>
    <ClientId> xs:string </ClientId>
    <ClientSecret> xs:string </ClientSecret>
    <UserAuthorizationEndpoint> xs:anyURI </UserAuthorizationEndpoint>
    <AccessTokenEndpoint> xs:anyURI </AccessTokenEndpoint>
    <UserInfoEndpoint> xs:anyURI </UserInfoEndpoint>
    <ScimEndpoint> xs:anyURI </ScimEndpoint>
    <Scope> xs:string </Scope>
    <OIDCAttributeMapping 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>
    <MaxClockSkew> xs:int </MaxClockSkew>
</OrgOAuthSettings>

Attributes

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

Elements

Element	Type	Required	Modifiable	Since	Description
AccessTokenEndpoint	anyURI	No	always	31.0	Identity Provider's OpenId Connect access token endpoint.
ClientId	string	No	always	31.0	Client Id for vCD to use when talking to the Identity Provider.
ClientSecret	string	No	always	31.0	Client Secret for vCD to use when talking to the Identity Provider.
Enabled	boolean	No	always	9.0	True if the OAuth Identity Provider for this organization is enabled. Unset or empty defaults to true.
IssuerId	string	No	always	9.0	Issuer Id for the OAuth Identity Provider.
Link	LinkType	No	none	9.0	A reference to an entity or operation associated with this object.
MaxClockSkew	int	No	always	31.0	Allowed difference between token expiration and vCD system time in seconds.
OAuthKeyConfigurations	OAuthKeyConfigurationsListType	No	none	9.0	A list of OAuth Key configurations.
OIDCAttributeMapping	OIDCAttributeMappingType	No	none	31.0	Custom claim keys for the /userinfo endpoint
OrgRedirectUri	string	No	none	36.0	OAuth redirect URI for this org. This value is read only
ScimEndpoint	anyURI	No	always	31.0	Identity Provider's SCIM user information endpoint.
Scope	string	No	always	31.0	Scope that vCD needs access to for authenticating the user.
UserAuthorizationEndpoint	anyURI	No	always	31.0	Identity Provider's OpenId Connect user authorization endpoint.
UserInfoEndpoint	anyURI	No	always	31.0	Identity Provider's OpenId Connect user info endpoint.
VCloudExtension	VCloudExtensionType	No	always	9.0	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since
read	GET /admin/org/{id}/settings/oauth	Retrieve organization OAuth settings.
update	PUT /admin/org/{id}/settings/oauth	Update organization OAuth settings.
delete	DELETE /admin/org/{id}/settings/oauth	Remove OAuth settings from an organization.	32.0
action	POST /admin/org/{id}/settings/oauth/openIdProviderConfig