Skip to main content
GET
List roles

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The Organization's ID.

Query Parameters

includeDefaultRoles
boolean

Whether to include default Astro roles in the returned list.

scopeTypes
enum<string>[]

Filter the list of roles based on the scope of each role.

Available options:
DEPLOYMENT,
WORKSPACE,
ORGANIZATION,
DAG
offset
integer
default:0

Offset for pagination.

Required range: x >= 0
limit
integer
default:20

Limit for pagination.

Required range: x >= 0
sorts
enum<string>[]

Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'.

Available options:
name:asc,
name:desc,
scopeType:asc,
scopeType:desc,
description:asc,
description:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

limit
integer
required

The number of custom roles returned.

Example:

1

offset
integer
required

The offset of the custom roles.

Example:

1

roles
object[]
required

The list of custom roles.

totalCount
integer
required

The total number of custom roles.

Example:

1

defaultRoles
object[]

The list of default roles.