{ "opencollection": "1.0.0", "info": { "name": "MongoDB Atlas Administration Access Tracking Federated Authentication API", "version": "2.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://cloud.mongodb.com/api/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Federated Authentication", "type": "folder" }, "items": [ { "info": { "name": "Delete One Federation Settings Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." } ] }, "docs": "Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation." }, { "info": { "name": "Return All Organization Configurations from One Federation", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "itemsPerPage", "value": "", "type": "query", "description": "Number of items that the response returns per page." }, { "name": "pageNum", "value": "", "type": "query", "description": "Number of the page that displays the current set of the total objects that the response returns." } ] }, "docs": "Returns all connected organization configurations 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." }, { "info": { "name": "Return One Organization Configuration from One Federation", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return." } ] }, "docs": "Returns the specified connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected organization." }, { "info": { "name": "Update One Organization Configuration in One Federation", "type": "http" }, "http": { "method": "PATCH", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. \n\n**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. \n\n**Note**: The `domainRestrictionEnabled` field defaults to false if not provided in the request. \n\n**Note**: If the `identityProviderId` field is" }, { "info": { "name": "Remove One Organization Configuration from One Federation", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove." } ] }, "docs": "Removes one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation." }, { "info": { "name": "Return All Role Mappings from One Organization", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access." } ] }, "docs": "Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role." }, { "info": { "name": "Create One Role Mapping in One Organization Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role." }, { "info": { "name": "Return One Role Mapping from One Organization", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings/:id", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "id", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access." } ] }, "docs": "Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role." }, { "info": { "name": "Update One Role Mapping in One Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings/:id", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "id", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role." }, { "info": { "name": "Remove One Role Mapping from One Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/connectedOrgConfigs/:orgId/roleMappings/:id", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "id", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access." } ] }, "docs": "Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role." }, { "info": { "name": "Return All Identity Providers in One Federation", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "itemsPerPage", "value": "", "type": "query", "description": "Number of items that the response returns per page." }, { "name": "pageNum", "value": "", "type": "query", "description": "Number of the page that displays the current set of the total objects that the response returns." }, { "name": "protocol", "value": "", "type": "query", "description": "The protocols of the target identity providers." }, { "name": "idpType", "value": "", "type": "query", "description": "The types of the target identity providers." } ] }, "docs": "Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no `idpType` is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations." }, { "info": { "name": "Create One Identity Provider", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "envelope", "value": "", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one identity provider within 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.\n\n**Note**: This resource only supports the creation of OIDC identity providers." }, { "info": { "name": "Return One Identity Provider by ID", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderId", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "identityProviderId", "value": "", "type": "path", "description": "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." }, { "name": "envelope", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. Deprecated versions: v2-{2023-01-01}" }, { "info": { "name": "Update One Identity Provider", "type": "http" }, "http": { "method": "PATCH", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderId", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "identityProviderId", "value": "", "type": "path", "description": "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." }, { "name": "envelope", "value": "", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.\n\n**Note**: When deactivating a SAML identity provider connected to an organization, the requesting Service Account or API key must have the Organization O" }, { "info": { "name": "Delete One Identity Provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderId", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "identityProviderId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the identity provider to connect." }, { "name": "envelope", "value": "", "type": "query", "description": "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." } ] }, "docs": "Deletes one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role for the connected organization. \n\n**Note**: Requests to this resource will fail if the identity provider is connected to more than one organization or is connected to an organization unowned by the requesting Service Account or API key. Before deleting an identity provider, confirm that no organization in your federation uses this identi" }, { "info": { "name": "Revoke JWKS from One OIDC Identity Provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderId/jwks", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "identityProviderId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the identity provider to connect." }, { "name": "envelope", "value": "", "type": "query", "description": "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." } ] }, "docs": "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be af" }, { "info": { "name": "Return Metadata of One Identity Provider", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/federationSettings/:federationSettingsId/identityProviders/:identityProviderId/metadata.xml", "params": [ { "name": "federationSettingsId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies your federation." }, { "name": "identityProviderId", "value": "", "type": "path", "description": "Legacy 20-hexadecimal digit string that identifies the identity provider. 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." } ] }, "docs": "Returns the metadata of 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." }, { "info": { "name": "Return Federation Settings for One Organization", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/orgs/:orgId/federationSettings", "params": [ { "name": "envelope", "value": "", "type": "query", "description": "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." }, { "name": "orgId", "value": "", "type": "path", "description": "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [`/orgs`](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access." }, { "name": "pretty", "value": "", "type": "query", "description": "Flag that indicates whether the response body should be in the prettyprint format." } ] }, "docs": "Returns information about the federation settings for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected organization." } ] } ], "bundled": true }