MOmongodb
Federated Authentication

Update One Organization Configuration in One Federation

Updates one connected organization configuration from the specified federation.

Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants.

Note: The domainRestrictionEnabled field defaults to false if not provided in the request.

Note: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider.

Note: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected.

patch/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}
  • 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:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.

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

dataAccessIdentityProviderIdsstring[]

The collection of unique ids representing the identity providers that can be used for data access in this organization.

domainAllowListstring[]

Approved domains that restrict users who can join the organization based on their email address.

domainRestrictionEnabledboolean required

Value that indicates whether domain restriction is enabled for this connected organization.

identityProviderIdstring nullable

Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected organization configuration is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.

instantUserProvisioningDisabledboolean nullable

Flag that indicates whether instant user provisioning is disabled for this connected organization.

orgIdstring required

Unique 24-hexadecimal digit string that identifies the connected organization configuration.

postAuthRoleGrantsstring[]

Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.

Example request

{
  "orgId": "32b6e34b3d91647abb20e7b8",
  "roleMappings": [
    {
      "id": "32b6e34b3d91647abb20e7b8",
      "roleAssignments": [
        {
          "groupId": "32b6e34b3d91647abb20e7b8",
          "orgId": "32b6e34b3d91647abb20e7b8"
        }
      ]
    }
  ],
  "userConflicts": [
    {
      "federationSettingsId": "32b6e34b3d91647abb20e7b8",
      "userId": "32b6e34b3d91647abb20e7b8"
    }
  ]
}

Response

OK

Changes

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