MOmongodb
Service Accounts

Update One Organization Service Account

Updates the specified Service Account in the specified Organization.

patch/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}

Request

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

Path parameters

clientIdstring required
Example:mdb_sa_id_1234567890abcdef12345678

The Client ID of the Service Account.

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.

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

descriptionstring nullable

Human readable description for the Service Account.

namestring nullable

Human-readable name for the Service Account. The name is modifiable and does not have to be unique.

rolesstring[]

A list of organization-level roles for the Service Account.

Response

OK

Changes

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