How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Federated Authentication API

Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.

MongoDB Federated Authentication API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Federated Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 18 operations across 10 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

18 operations 10 paths 26 schemas 5 DELETE8 GET2 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Federated Authentication API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 18

Across 10 paths, the API surfaces 18 operations — 5 DELETE, 8 GET, 2 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Federated Authentication 18

Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.

DELETE
/api/atlas/v2/federationSettings/{federationSettingsId}
Delete One Federation Settings Instance
deleteFederationSetting 1 param → 204400401403404429500
GET
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs
Return All Organization Configurations from One Federation
listFederationSettingConnectedOrgConfigs 4 params → 200400401403404429500
DELETE
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}
Remove One Organization Configuration from One Federation
removeFederationSettingConnectedOrgConfig 3 params → 204400401403404429500
GET
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}
Return One Organization Configuration from One Federation
getFederationSettingConnectedOrgConfig 3 params → 200400401403404429500
PATCH
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}
Update One Organization Configuration in One Federation
updateFederationSettingConnectedOrgConfig 3 params body → 200400401403404429500
GET
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings
Return All Role Mappings from One Organization
listFederationSettingConnectedOrgConfigRoleMappings 3 params → 200400401403404429500
POST
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings
Create One Role Mapping in One Organization Configuration
createFederationSettingConnectedOrgConfigRoleMapping 3 params body → 200400401403404429500
DELETE
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}
Remove One Role Mapping from One Organization
deleteFederationSettingConnectedOrgConfigRoleMapping 4 params → 204400401403404429500
GET
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}
Return One Role Mapping from One Organization
getFederationSettingConnectedOrgConfigRoleMapping 4 params → 200400401403404429500
PUT
/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}
Update One Role Mapping in One Organization
updateFederationSettingConnectedOrgConfigRoleMapping 4 params body → 200400401403404429500
GET
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders
Return All Identity Providers in One Federation
listFederationSettingIdentityProviders 6 params → 200400401403404429500
POST
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders
Create One Identity Provider
createFederationSettingIdentityProvider 2 params body → 200400401403404429500
DELETE
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}
Delete One Identity Provider
deleteFederationSettingIdentityProvider 3 params → 204400401403404429500
GET
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}
Return One Identity Provider by ID
getFederationSettingIdentityProvider 3 params → 200400401403404429500
PATCH
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}
Update One Identity Provider
updateFederationSettingIdentityProvider 3 params body → 200400401403404405429500
DELETE
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks
Revoke JWKS from One OIDC Identity Provider
revokeFederationSettingIdentityProviderJwks 3 params → 204400401403404429500
GET
/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml
Return Metadata of One Identity Provider
getFederationSettingIdentityProviderMetadata 2 params → 200400401403404405429500
GET
/api/atlas/v2/orgs/{orgId}/federationSettings
Return Federation Settings for One Organization
getOrgFederationSettings 3 params → 200400401403404429500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are FederationSamlIdentityProvider (20 properties), FederationOidcWorkforceIdentityProvider (17 properties), FederationOidcIdentityProvider (14 properties), FederationOidcWorkloadIdentityProvider (14 properties). Each schema is shown below with its type and property counts.

FederationSamlIdentityProviderUpdate
object
13 properties 1 required
PemFileInfo
object
PEM file information for the identity provider's current certificates.
2 properties
FederationOidcIdentityProvider
object
14 properties 2 required
PaginatedRoleMappingView
object
List role mappings from the specified organization in the specified federation.
3 properties 1 required
ApiError
object
6 properties 2 required
Link
object
2 properties
FieldViolation
object
2 properties 2 required
FederationOidcWorkforceIdentityProviderUpdate
object
12 properties
ConnectedOrgConfig
object
8 properties 2 required
X509Certificate
object
2 properties
FederationIdentityProviderUpdate
object
5 properties
FederationOidcWorkloadIdentityProviderUpdate
object
9 properties
ConnectedOrgConfigRoleAssignment
object
3 properties
OrgFederationSettings
object
Details that define how to connect one MongoDB Cloud organization to one federated authentication service.
5 properties 1 required
FederationSamlIdentityProvider
object
20 properties 2 required
FederationOidcWorkloadIdentityProvider
object
14 properties 2 required
PemFileInfoUpdate
object
PEM file information for the identity provider's current certificates.
2 properties
FederationOidcWorkforceIdentityProvider
object
17 properties 2 required
FederationOidcIdentityProviderUpdate
object
9 properties
FederatedUser
object
MongoDB Cloud user linked to this federated authentication.
5 properties 4 required
X509CertificateUpdate
object
3 properties
PaginatedFederationIdentityProvider
object
3 properties 1 required
BadRequestDetail
object
Bad request detail.
1 property
FederationIdentityProvider
object
10 properties 2 required
AuthFederationRoleMapping
object
Mapping settings that link one IdP and MongoDB Cloud.
3 properties 2 required
PaginatedConnectedOrgConfigsView
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-federated-authentication-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

This is an independent, third-party profile of MongoDB Federated Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.