Roles

Create

Creates a role.

POST /roles
const response = await client.roles.create(
  { role: 'admin' }
);
Parameters
NameDescription
rolestring, required

Name of the role.

Response
NameDescription
dataobject

Role object.

{
  "data": {
    "id": "role_abc123",
    "role": "admin"
  }
}

List

Lists all roles.

GET /roles
const response = await client.roles.list();
Response
NameDescription
dataobject[]

List of roles.

{
  "data": [
    {
      "id": "role_abc123",
      "role": "admin"
    }
  ]
}