Return One Role Mapping
On this page
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 |
|---|---|---|
| string | Unique 24-hexadecimal digit string that identifies the federated authentication configuration. |
| string | Unique 24-hexadecimal digit string that identifies the connected organization. |
| 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. |
| ||||||
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:
|
|
Request Body Parameters
This endpoint does not use HTTP request body parameters.
Response
Name | Type | Description |
|---|---|---|
| string | Unique human-readable label that identifies the identity provider group associated with the role mapping. |
| string | Unique 24-hexadecimal digit string that identifies the role mapping. |
| array | List that contains the unique identifiers for the projects and organizations associated with each role. |
| string | Unique 24-hexadecimal digit string that identifies the project in which the role applies. |
| string | Unique 24-hexadecimal digit string that identifies the organization in which the role applies. |
| 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" } ] }