- API >
- Cloud Manager Administration API Resources >
- Federated Authentication Configuration >
- Return One Role Mapping
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¶
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:
|
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. |