Create a Role

⚠

️

The resource_id field within the permissions array is only necessary when the role grants access to a specific environment. For all other permission types, this field should be omitted.

To find the resource_id, run a Retrieve all Roles call.

📘

The resource_type field is the name of the permission, without the access level. For example, roles rather than roles_read.

For a list of available permission types, see the Roles and Resource Permissions documentation.

For information about finding the resource_type at the environment level, see the Granular Environment Permissions documentation.

📘

System fields (id, created_by, created_at, and updated_at) will be set automatically. If included in the Create payload, these fields will be discarded.