Org / Org Roles /

List org roles

Gets a list of platform roles for the authenticated org.

Required permission

Os > Admin > Roles > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

roles
[array] required
An array of org roles.

{object}
An org role object.

id
string required
ID of the role.
pattern
^[A-Za-z0-9-]+$
name
string required
Display name of the role.
description
string
Description of the role.
restrictions
{object} required

enabled
boolean required
Whether restrictions are enabled.

createdAt
string
Creation time.
updatedAt
string
Last updated.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/org-roles

Example response

200 OK

A list of platform roles for the org.

JSON

{
  "data": {
    "roles": [
      {
        "id": "developer",
        "name": "Developer",
        "description": "Role for developers.",
        "createdAt": "2021-01-20T11:19:53.175Z",
        "updatedAt": "2021-01-20T11:19:53.175Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}