You were redirected from a different version of the documentation. Click here to go back.

Return the Federation Configuration for One Organization

The federationSettings resource allows you to return the federated authentication configuration for one organization.

Base URL:

Required Roles

You must have the Organization Owner role to call this endpoint.


GET /orgs/{ORG-ID}/federationSettings

Request Path Parameters

Name Type Description
ORG-ID string Unique 24-hexadecimal digit string that identifies the organization.

Request Query Parameters

The following query parameters are optional:

Name Type Necessity Description Default
pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

Name Description
status HTTP response code
envelope Expected response body

Request Body Parameters

This endpoint does not use HTTP request body parameters.


Name Type Description
federatedDomains array of strings List that contains the domains associated with the organization’s identity provider.
hasRoleMappings boolean

Flag that indicates whether this organization has role mappings configured.

To learn more about role mapping, see Manage Mapping Cloud Manager Roles to IdP Groups.

id string Unique 24-hexadecimal digit string that identifies this federation.
identityProviderId string Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization.
identityProviderStatus string Value that indicates whether the identity provider is active. Cloud Manager returns ACTIVE if the identity provider is active and INACTIVE if the identity provider is inactive.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "{ORG-ID}/federationSettings"

Example Response

  "federatedDomains": [
  "hasRoleMappings": false,
  "id": "5e8cc670a16506712e0b1e95",
  "identityProviderId": "0oa8i0grsgbwDiIyw453",
  "identityProviderStatus": "INACTIVE"