Get Role

Gets an authorization role’s details.

Authorizations

Authorization

string

header

required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer

integer

default:

0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x > 0

Path Parameters

role_id

integer

required

ID of the role record to retrieve info for.

Response

200

application/json

OK

data

object

Show child attributes

data.id

integer

This is the unique identifier for this object.

data.created_at

string

data.updated_at

string

data.deleted_at

object

Show child attributes

data.deleted_at.time

string

An RFC-3339 formatted string

data.deleted_at.valid

boolean

Valid is true if time is not null.

data.name

string

data.description

string

data.permissions

object[]

Show child attributes

data.permissions.id

integer

This is the unique identifier for this object.

data.permissions.created_at

string

data.permissions.updated_at

string

data.permissions.deleted_at

object

Show child attributes

data.permissions.deleted_at.time

string

An RFC-3339 formatted string

data.permissions.deleted_at.valid

boolean

Valid is true if time is not null.

data.permissions.authority

string

data.permissions.name

string