Update a service account

To manage roles associated with a service account after creation, pass the service_account_id instead of a user_id to any Role Management endpoint.

Can be used by the following roles assigned at the organization scope:

• ORG_ADMIN

PATCH /api/v1/service-accounts/{id}

cURL

cURL

curl --request PATCH \
  --url https://cockroachlabs.cloud/api/v1/service-accounts/{id} \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"description":"new description","name":"new name"}'

200

{
  "created_at": "2022-03-22T20:23:11.285067Z",
  "creator_name": "creator",
  "description": "",
  "group_roles": [],
  "id": "12345678-1234-1234-1234-123456789012",
  "name": "SA Name",
  "roles": [
    {
      "name": "CLUSTER_ADMIN",
      "resource": {
        "type": "ORGANIZATION"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The ID of the service account.

Body

application/json

The service account fields to update. Omitted fields are left unchanged.

description · string

description of the service account.

name · string

name of the service account.

Response

200

application/json

A successful response.

A service account is an identity scoped to an organization that represents a non-human user.

created_at · string<date-time> · required

created_at represents the creation time of the service account.

creator_name · string · required

creator_name is the name of user that created the service account.

description · string · required

description of the service account.

group_roles · object[] · required

roles that the service account has inherited via a group.

Show child attributes

id · string · required

The ID of the service account.

name · string · required

name of the service account.

roles · object[] · required

roles that are assigned to the service account.

Show child attributes