atlas api federatedAuthentication updateIdentityProvider

On this page

experimental: Updates one identity provider in the specified federation.

To use this resource, the requesting 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.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax

atlas api federatedAuthentication updateIdentityProvider [options]

Name	Type	Required	Description
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--federationSettingsId	string	true	unique 24-hexadecimal digit string that identifies your federation
--file	string	false	path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
-h, --help		false	help for updateIdentityProvider
--identityProviderId	string	true	unique string that identifies the identity provider to connect
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--version	string	false	api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15".

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.

Back

updateConnectedOrgConfig

updateRoleMapping