MOmongodb
Federated Authentication

Create One Role Mapping in One Organization Configuration

Adds one role mapping to the specified organization in the specified federation.

post/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

federationSettingsIdstring required
Example:55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

orgIdstring required
Example:4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request body

externalGroupNamestring required

Unique human-readable label that identifies the identity provider group to which this role mapping applies.

idstring

Unique 24-hexadecimal digit string that identifies this role mapping.

Example request

{
  "id": "32b6e34b3d91647abb20e7b8",
  "roleAssignments": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8"
    }
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.