listRoles

GET

/api/v1/roles

const url = 'https://example.com/api/v1/roles';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/roles

List the built-in and custom roles with their capabilities and member counts. Requires users.manage or roles.manage and the admin scope.

Responses

200

Roles

application/json

object

data

required

object

items

required

Array<object>

object

key

required

Role key. The built-in roles are owner, administrator, editor, contributor, and viewer. Custom role keys start with “custom.”. Decide authorization from the capabilities the server reports, not from the role key.

string

/^[a-z][a-z0-9.-]{1,63}$/

name

required

string

description

required

string

builtin

required

boolean

capabilities

required

Array<string>

userCount

required

Active accounts on the role.

integer

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

editable

required

Whether the caller may change or delete the role.

boolean

assignable

required

Whether the caller may place accounts on the role.

boolean

Example

{
  "data": {
    "items": [
      {
        "key": "owner"
      }
    ]
  }
}

401

Dashboard authentication required

403

Insufficient role