atlas api federatedAuthentication
Public Preview: please provide feedback: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Options
Name | Type | Required | Description |
---|---|---|---|
-h, --help | false | help for federatedAuthentication |
Inherited Options
Name | Type | Required | Description |
---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Related Commands
atlas api federatedAuthentication createIdentityProvider - Public Preview: please provide feedback: Creates one identity provider within the specified federation.
atlas api federatedAuthentication createRoleMapping - Public Preview: please provide feedback: Adds one role mapping to the specified organization in the specified federation.
atlas api federatedAuthentication deleteFederationApp - Public Preview: please provide feedback: Deletes the federation settings instance and all associated data, including identity providers and domains.
atlas api federatedAuthentication deleteIdentityProvider - Public Preview: please provide feedback: Deletes one identity provider in the specified federation.
atlas api federatedAuthentication deleteRoleMapping - Public Preview: please provide feedback: Removes one role mapping in the specified organization from the specified federation.
atlas api federatedAuthentication getConnectedOrgConfig - Public Preview: please provide feedback: Returns the specified connected org config from the specified federation.
atlas api federatedAuthentication getFederationSettings - Public Preview: please provide feedback: Returns information about the federation settings for the specified organization.
atlas api federatedAuthentication getIdentityProvider - Public Preview: please provide feedback: Returns one identity provider in the specified federation by the identity provider's id.
atlas api federatedAuthentication getIdentityProviderMetadata - Public Preview: please provide feedback: Returns the metadata of one identity provider in the specified federation.
atlas api federatedAuthentication getRoleMapping - Public Preview: please provide feedback: Returns one role mapping from the specified organization in the specified federation.
atlas api federatedAuthentication listConnectedOrgConfigs - Public Preview: please provide feedback: Returns all connected org configs in the specified federation.
atlas api federatedAuthentication listIdentityProviders - Public Preview: please provide feedback: Returns all identity providers with the provided protocol and type in the specified federation.
atlas api federatedAuthentication listRoleMappings - Public Preview: please provide feedback: Returns all role mappings from the specified organization in the specified federation.
atlas api federatedAuthentication removeConnectedOrgConfig - Public Preview: please provide feedback: Removes one connected organization configuration from the specified federation.
atlas api federatedAuthentication revokeJwksFromIdentityProvider - Public Preview: please provide feedback: Revokes the JWKS tokens from the requested OIDC identity provider.
atlas api federatedAuthentication updateConnectedOrgConfig - Public Preview: please provide feedback: Updates one connected organization configuration from the specified federation.
atlas api federatedAuthentication updateIdentityProvider - Public Preview: please provide feedback: Updates one identity provider in the specified federation.
atlas api federatedAuthentication updateRoleMapping - Public Preview: please provide feedback: Updates one role mapping in the specified organization in the specified federation.