Role

Where you fall within your organization's structure.

createdAt
string <date-time>

The date and time the team was created.

name
string <= 255 characters

The name of the role (e.g. "Vice-President").

updatedAt
string <date-time>

The date and time the team was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Role Relationships

data (object) or links (object) (role)

Roles are heirarchical. This is the parent of the current role. You can use only the attribute id to filter roles by parentRole (e.g. filter[parentRole][id]=X).

{
  • "parentRole": {
    }
}

Role Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Role Actions

Get a Collection of Roles

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/roles
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Role
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/roles
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Role by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/roles/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Role by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/roles/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Role
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/roles/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}