MOmongodb
Programmatic API Keys

Assign One Organization API Key to One Project

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.

post/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

apiUserIdstring required

Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.

Query parameters

envelopeboolean

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.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

rolesstring[]

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.

userIdstring

Unique 24-hexadecimal digit string that identifies the organization API key.

Example request

[
  {
    "userId": "32b6e34b3d91647abb20e7b8"
  }
]

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.