Sign in

v1

latestOpenAPI 3.0.1CC BY-NC-SA 3.0 US2026-07-145251,1312.6 MB
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}

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.

Response

OK