Adds the user to the given role

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'

{
  "roles": [
    {
      "resource": {
        "id": "<string>"
      }
    }
  ]
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

POST

api

roles

{user_id}

{resource_type}

{resource_id}

{role_name}

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'

{
  "roles": [
    {
      "resource": {
        "id": "<string>"
      }
    }
  ]
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

This endpoint is in Preview and subject to change. Refer to the API support policy for more details.

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

resource_type

enum<string>

required

Available options:

ORGANIZATION,

CLUSTER

resource_id

string

required

role_name

enum<string>

required

Available options:

ORG_ROLE_DEVELOPER,

ORG_ROLE_ADMIN,

ORG_ROLE_BILLING_COORDINATOR,

ORG_ROLE_ORG_ADMIN,

ORG_ROLE_ORG_MEMBER,

ORG_ROLE_CLUSTER_ADMIN,

ORG_ROLE_CLUSTER_OPERATOR_WRITER,

ORG_ROLE_CLUSTER_OPERATOR_READER,

ORG_ROLE_CLUSTER_DEVELOPER,

ORG_ROLE_CLUSTER_CREATOR

Response

A successful response.

roles

object[]

Show child attributes

Makes the users roles exactly those provided Removes the user from the given role

Overview

Endpoints

Adds the user to the given role

Authorizations

Path Parameters

Response