Add a role to a user, service account, or group

Add a single role to a user, service account, or group by providing its ID in the user_id path parameter.

Roles that will be added as a result of this call must follow the CC rules for role assignment: https://docs.cockroachlabs.com/docs/cockroachcloud/authorization#organization-user-roles

POST /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}

cURL

cURL

curl --request POST \
  --url https://cockroachlabs.cloud/api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name} \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

200

{
  "group_roles": [
    {
      "group_names": [
        "<string>"
      ],
      "role": {
        "name": "BILLING_COORDINATOR",
        "resource": {
          "type": "ORGANIZATION",
          "id": "<string>"
        }
      }
    }
  ],
  "roles": [
    {
      "name": "BILLING_COORDINATOR",
      "resource": {
        "type": "ORGANIZATION",
        "id": "<string>"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

user_id · string · required

user_id is the ID of the user, service account, or group to add the role to.

resource_type · enum<string> · required

resource_type is the type of resource the role applies to.

Available options: ORGANIZATION, CLUSTER, FOLDER

resource_id · string · required

resource_id is the ID of the resource the role applies to. Pass an empty string for organization-scoped roles.

role_name · enum<string> · required

role_name is the role to grant.

Available options: BILLING_COORDINATOR, ORG_ADMIN, ORG_MEMBER, CLUSTER_ADMIN, CLUSTER_OPERATOR_WRITER, CLUSTER_DEVELOPER, CLUSTER_CREATOR, FOLDER_ADMIN, FOLDER_MOVER, METRICS_VIEWER, CLUSTER_MONITOR, BILLING_VIEWER, AUDITOR, CLUSTER_DATA_ACCESSOR

Response

200

application/json

A successful response.

group_roles · object[]

Show child attributes

roles · object[]

Show child attributes