atlas api federatedAuthentication createRoleMapping
On this page
experimental: Adds one role mapping to the specified organization in the specified federation.
To use this resource, the requesting 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/createRoleMapping.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api federatedAuthentication createRoleMapping [options]
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 createRoleMapping | |
--orgId | string | true | unique 24-hexadecimal digit string that identifies the organization that contains your projects |
--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-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. |