Docs Menu

Docs Home → MongoDB Cloud Manager

Remove One Role Mapping

On this page

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

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

DELETE /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
envelope
Expected response body
false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

This endpoint does not return a response body.

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

This endpoint does not return a response body.

← Return One Identity Provider's Metadata
Remove One Federation →

On this page