• API >
• Cloud Manager Administration API Resources >
• Federated Authentication Configuration >
• Return One Connected Organization

Return One Connected Organization

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

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 /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/

Request Path Parameters

Name	Type	Description
FEDERATION-SETTINGS-ID	string	Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
ORG-ID	string	Unique 24-hexadecimal digit string that identifies the connected 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	false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Name	Type	Description
domainAllowList	array	List that contains the approved domains from which organization users can log in.
domainRestrictionEnabled	boolean	Flag that indicates whether domain restriction is enabled for the connected organization. Note userConflicts returns null when "domainRestrictionEnabled": false.
identityProviderId	string	Unique 20-hexadecimal digit string that identifies the identity provider associated with the connected organization.
orgId	string	Unique 24-hexadecimal digit string that identifies the connected organization.
postAuthRoleGrants	array	List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
roleMappings	array	List that contains the role mappings configured in this organization.
userConflicts	array	List that contains the usernames that don’t match any domain on the allowed list. Note userConflicts returns null when "domainRestrictionEnabled": false.

Example Request

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}"

Example Response

{
 "domainAllowList": [],
 "domainRestrictionEnabled": false,
 "identityProviderId": null,
 "orgId": "5f86fb11e0079069c9ec3132",
 "postAuthRoleGrants": [],
 "roleMappings": [],
 "userConflicts": null
}

←   Return All Connected Organizations Update One Connected Organization  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.