atlas api programmaticApiKeys addProjectApiKey
On this page
experimental: Assigns the specified organization API key to the specified project.
Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'addProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey
Syntax
atlas api programmaticApiKeys addProjectApiKey [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--apiUserId | string | true | unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project |
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--file | string | false | path to the file which contains the api request contents |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for addProjectApiKey | |
--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) |
--pretty | false | flag that indicates whether the response body should be in the prettyprint format | |
--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. |