ANNOUNCEMENT: Voyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas.
Learn more
Docs Menu

Return One Role Mapping

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

You must have the Organization Owner role to call this endpoint.

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}
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.

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

This endpoint does not use HTTP request body parameters.

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.

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}"
{
"externalGroupName": "autocomplete-highlight",
"id": "61d88e15e6cc044270a36fce",
"roleAssignments": [
{
"groupId": null,
"orgId": "5f86fb11e0079069c9ec3132",
"role": "ORG_OWNER"
},
{
"groupId": "5f86fb2ff9c4e56d39502559",
"orgId": null,
"role": "GROUP_OWNER"
}
]
}