Return the Federation Configuration for One Organization
On this page
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
The federationSettings resource allows you to return the
federated authentication configuration for one organization.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Required Roles
You must have the Organization Owner role to call this
endpoint.
Resource
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:
| false |
Request Body Parameters
This endpoint does not use HTTP request body parameters.
Response
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 "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/federationSettings"
Example Response
{ "federatedDomains": [ "example.com" ], "hasRoleMappings": false, "id": "5e8cc670a16506712e0b1e95", "identityProviderId": "0oa8i0grsgbwDiIyw453", "identityProviderStatus": "INACTIVE" }