atlas api federatedAuthentication updateRoleMapping

Atlas CLI support for running commands with the Atlas Administration API is in Preview. The feature and the corresponding documentation might change at any time during the Preview period. To learn more, see Preview Features.

Public Preview: please provide feedback: Updates one role mapping in the specified organization in the specified federation.

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.

To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping.

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

Syntax

Command Syntax

atlas api federatedAuthentication updateRoleMapping [options]

Options

Name	Type	Required	Description
--envelope	envelope	false	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.
--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 updateRoleMapping
--id	string	true	Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.
--orgId	string	true	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.
-o, --output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--outputFile	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-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

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.

Back

updateIdentityProvider

flexClusters