MOmongodb
Federated Authentication

Update One Identity Provider

Updates one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations.

Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.

Note: When deactivating a SAML identity provider connected to an organization, the requesting Service Account or API key must have the Organization Owner role for the organization. If the identity provider is connected to multiple organizations, the request will fail.

patch/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}

Request

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

identityProviderIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. 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. For all other versions, use the 24-hexadecimal digit id.

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

associatedDomainsstring[]

List that contains the domains associated with the identity provider.

descriptionstring nullable

The description of the identity provider.

displayNamestring

Human-readable label that identifies the identity provider.

idpType'WORKFORCE' | 'WORKLOAD'

String enum that indicates the type of the identity provider. Default is WORKFORCE.

issuerUristring

Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.

protocol'SAML' | 'OIDC'

String enum that indicates the protocol of the identity provider. Either SAML or OIDC.

requestBinding'HTTP-POST' | 'HTTP-REDIRECT'

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.

responseSignatureAlgorithm'SHA-1' | 'SHA-256'

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.

slugstring

Custom SSO URL for the identity provider.

ssoDebugEnabledboolean required

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrlstring

URL that points to the receiver of the SAML authentication request.

status'ACTIVE' | 'INACTIVE' nullable

String enum that indicates whether the identity provider is active.

Example request

{
  "issuerUri": "urn:idp:default",
  "ssoUrl": "https://example.com"
}

Response

OK

Changes

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