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 | Deprecated | 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 | |
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 | Deprecated |
---|---|---|---|---|
read | GET /admin/org/{id}/settings/oauth | Retrieve organization OAuth settings. | ||
update | PUT /admin/org/{id}/settings/oauth | Update organization OAuth settings. |