API ReferenceRoles

Create Role

Creates a new role.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
targetenumRequired
Target object type of the role.
descriptionstringOptionalformat: "text"
The description of the role.
include_all_subtypesbooleanOptional
Whether to include all subtypes of the leaf type as target of the role.
namestringOptionalformat: "text"
The name of the role.
privilegeslist of enumsOptional
The privileges the role provides on target.
Allowed values:
target_subtypestringOptionalformat: "text"
The subtype of the target.

Response

A response to a request to create a new role.
roleobject

Errors