MOmongodb
Programmatic API Keys

Update One Organization API Key

Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization.

patch/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}

Request

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

Path parameters

orgIdstring required
Example:4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

apiUserIdstring required

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

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

descstring

Purpose or explanation provided when someone creates this organization API key.

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 organization.

Response

OK

Changes

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