VMware Cloud Director API - OrgFederationSettings

OrgFederationSettingsType

Element:

OrgFederationSettings

Type:

OrgFederationSettingsType

Namespace:

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

Description:

Represents federation settings for identity federation.

Since:

5.1

Schema:

vCloudEntities.xsd

Media type(s):

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

Extends:

ResourceType

XML Representation:

<OrgFederationSettings 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"/>
    <SAMLMetadata> xs:string </SAMLMetadata>
    <Enabled> xs:boolean </Enabled>
    <CertificateExpiration> xs:dateTime </CertificateExpiration>
    <SigningCertificateExpiration> xs:dateTime </SigningCertificateExpiration>
    <EncryptionCertificateExpiration> xs:dateTime </EncryptionCertificateExpiration>
    <SamlSPEntityId> xs:anyURI </SamlSPEntityId>
    <SamlAttributeMapping 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"/>
        <EmailAttributeName> xs:string </EmailAttributeName>
        <UserNameAttributeName> xs:string </UserNameAttributeName>
        <FirstNameAttributeName> xs:string </FirstNameAttributeName>
        <SurnameAttributeName> xs:string </SurnameAttributeName>
        <FullNameAttributeName> xs:string </FullNameAttributeName>
        <GroupAttributeName> xs:string </GroupAttributeName>
        <RoleAttributeName> xs:string </RoleAttributeName>
    </SamlAttributeMapping>
    <SigningCertLibraryItemId> xs:string </SigningCertLibraryItemId>
    <EncryptionCertLibraryItemId> xs:string </EncryptionCertLibraryItemId>
    <CustomUiButtonLabel> xs:string </CustomUiButtonLabel>
</OrgFederationSettings>

Attributes

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

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
CertificateExpiration	dateTime	No	none	5.6	36.0	The expiration time of this org's certificate. Deprecated in favor of SigningCertificateExpiration and EncryptionCertificateExpiration
CustomUiButtonLabel	string	No	always	38.1		Custom label to use when displaying this SAML configuration on the VCD login pane. If null, a default label will be used.
Enabled	boolean	No	always	5.1		This boolean value indicates whether the Identity Provider for the organization is enabled or disabled.
EncryptionCertLibraryItemId	string	No	update	36.0		UUID of a CertificateLibraryItem containing a certificate chain and private key for SAML encryption
EncryptionCertificateExpiration	dateTime	No	none	36.0		The expiration time of this org's encryption certificate.
Link	LinkType	No	none	5.1		A reference to an entity or operation associated with this object.
SAMLMetadata	string	No	always	5.1		XML-encoded SAML 2.0 metadata from this organization's identity provider. If empty, this organization does not support SAML. Download this content over a secure connection from a trusted source (typically your identity provider's SAML metadata URL).
SamlAttributeMapping	SamlAttributeMappingType	No	none	31.0		The names of SAML attributes used to populate user profiles.
SamlSPEntityId	anyURI	Yes	always	5.6		Service Provider Entity ID to be used when generating SP Metadata
SigningCertLibraryItemId	string	No	update	36.0		UUID of a CertificateLibraryItem containing a certificate chain and private key for SAML signing
SigningCertificateExpiration	dateTime	No	none	36.0		The expiration time of this org's signing certificate.
VCloudExtension	VCloudExtensionType	No	always	5.1		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/federation	Retrieve other organization settings.	1.5
update	PUT /admin/org/{id}/settings/federation	Update other organization settings.	1.5
action	POST /admin/org/{id}/settings/federation/action/regenerateFederationCertificate	Regenerates the certificates used to establish trust between an organization and its identity provider	5.6