Get role

GET

/api/v1/roles/{name}

Returns a single role by its uppercase name.

Authorizations

• bearerAuth

Parameters

Path Parameters

name

required

string

Uppercase role name

Responses

200

Role found

object

name

string

permissions

Array<string>

builtIn

required

boolean

userCount

required

integer format: int64

401

Unauthorized

object

error

object

code

string

message

string

status

required

integer format: int32

403

Forbidden

object

error

object

code

string

message

string

status

required

integer format: int32

404

Role not found

object

error

object

code

string

message

string

status

required

integer format: int32