Docs Home → MongoDB Cloud Manager
Return All Connected Organizations
On this page
The federationSettings
resource allows you to return all
connected organizations for a
federated authentication configuration.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Required Roles
You must have the Organization Owner
role for at least one
connected organization in the federation configuration to call this
endpoint.
Resource
GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/
Request Path Parameters
Name | Type | Description |
---|---|---|
FEDERATION-SETTINGS-ID | string | Unique 24-hexadecimal digit string that identifies the federated
authentication configuration. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. | 1 |
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. | 100 |
pretty | boolean | Optional | Flag that indicates 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 For endpoints that return a list of results, the | false |
backupJobsEnabledOnly | boolean | Optional | Flag indicating whether to exclude daemons not enabled for
backing up databases from the response. Set this to false to
include daemon configurations with the backupJobsEnabled
flag set to false . | true |
Request Body Parameters
This endpoint does not use HTTP request body parameters.
Response
Response Document
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results | array of objects | One object for each item detailed in the
results Embedded Document section. |
links | array of objects | One or more links to sub-resources and/or related resources. All
|
totalCount | integer | Count of the total number of items in the result set. It may
be greater than the number of objects in the results
array if the entire result set is paginated. |
results Embedded Document
Each document in the result
array contains the federated
authentication configuration for each connected organization.
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
|
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
|
Example Request
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"
Example Response
{ "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "domainAllowList": [], "domainRestrictionEnabled": false, "identityProviderId": null, "orgId": "5f86fb11e0079069c9ec3132", "postAuthRoleGrants": [], "roleMappings": [], "userConflicts": null } ], "totalCount": 1 }