Return One Role Mapping

On this page

Required Roles
Resource
Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Example Request
Example Response

Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.

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 one role mapping from the specified organization in the specified federation.

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}/roleMappings/{ROLE-MAPPING-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.
`ROLE-MAPPING-ID`	string	Unique 24-hexadecimal digit string that identifies the role mapping.

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
`content`	Expected response body

false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Name	Type	Description
`externalGroupName`	string	Unique human-readable label that identifies the identity provider group associated with the role mapping.
`id`	string	Unique 24-hexadecimal digit string that identifies the role mapping.
`roleAssignments`	array	List that contains the unique identifiers for the projects and organizations associated with each role.
`roleAssignments.groupId`	string	Unique 24-hexadecimal digit string that identifies the project in which the role applies.
`roleAssignments.orgId`	string	Unique 24-hexadecimal digit string that identifies the organization in which the role applies.
`roleAssignments.role`	string	Human readable label that identifies the role.

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/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}"

Example Response

{
 "externalGroupName": "autocomplete-highlight",
 "id": "61d88e15e6cc044270a36fce",
 "roleAssignments": [
     {
         "groupId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "role": "ORG_OWNER"
     },
     {
         "groupId": "5f86fb2ff9c4e56d39502559",
         "orgId": null,
         "role": "GROUP_OWNER"
     }
 ]
}

Back

Return All Role Mappings

Return All Identity Providers