Sign in

v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB
Roles

Create a Role

Create a new role.

post/roles

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

descriptionstring

Description of the role.

enforce_tfaboolean

Whether or not this role enforces the use of 2FA.

external_idstring

ID used with external services in SCIM.

ip_accessstring[]

Array of IP addresses that are allowed to connect to the API as a user of this role.

module_listingstring

Custom override for the admin app module bar navigation.

namestring

Name of the role.

Example request

{
  "name": "Interns"
}

Response

Successful request