List Roles

GET 
/roles/

Request

Query Parameters

assignable_to object
custom boolean
length integerrequired

Number of results to return per page.

ordering stringrequired

Which field to use when ordering the results.

page integerrequired

A page number within the paginated result set.

search stringrequired

A search term.

Responses

200

application/json

Schema

Schema

count integerrequired

Total number of results.

page_total integerrequired

Total number of pages.

page integerrequired

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integerrequired

Number of results returned per page.

results object[]
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Role's name.
permissions object[]
Array [
id stringrequired
Possible values: <= 255 characters
Textual identifier.
name stringrequired
Possible values: <= 255 characters
Permission name.
]
custom booleanrequired
description stringnullablerequired
Short description.
]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "name": "string",
      "permissions": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "custom": true,
      "description": "string"
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...