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 | The expiration time of this org's certificate. | |
Enabled | boolean | No | always | 5.1 | This boolean value indicates whether the Identity Provider for the organization is enabled or disabled. | |
Link | LinkType | No | none | 5.1 | A reference to an entity or operation associated with this object. | |
RoleAttributeName | string | No | always | 7.0 | The name of the SAML attribute that returns the identifiers of all the groups of which the user is a member. | |
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). | |
SamlSPEntityId | anyURI | Yes | always | 5.6 | Service Provider Entity ID to be used when generating SP Metadata | |
SamlSPKeyAndCertificateChain | SamlSPKeyAndCertificateChainType | No | update | 24.0 | Container for an organization's PEM-encoded private key and certificate chain. The private key and the public key from the leaf certificate are used during SAML message processing. Not returned on GET | |
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 | Deprecated |
---|---|---|---|---|
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 |