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"/>
    <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"/>
        <OAuthKeyConfiguration href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <KeyId> xs:string </KeyId>
            <Algorithm> xs:string </Algorithm>
            <Key> xs:string </Key>
            <ExpirationDate> xs:dateTime </ExpirationDate>
        </OAuthKeyConfiguration>
    </OAuthKeyConfigurations>
    <Enabled> xs:boolean </Enabled>
</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	Deprecated	Description
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.
OAuthKeyConfigurations	OAuthKeyConfigurationsListType	No	none	9.0		A list of OAuth Key configurations.
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.