IAM API ReferenceRole

Create a custom role

Create a custom role that you can assign to users, Teams, and API tokens.

Path parameters

organizationIdstringRequired
The ID of the Organization where you want to create the custom role.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired
The role's name.
permissionslist of stringsRequired
The permissions included in the role.
scopeTypeenumRequired
The scope of the role.
Allowed values:
descriptionstringOptional
The role's description.
restrictedWorkspaceIdslist of stringsOptional
The IDs of the Workspaces that the role is restricted to.

Response

OK
createdAtstring
The time the role was created.
createdByobject
idstring
The role's ID.
namestring
The role's name.
permissionslist of strings
The role's permissions.
restrictedWorkspaceIdslist of strings
The IDs of Workspaces that the role is restricted to.
scopeTypeenum
The role's scope.
Allowed values:
updatedAtstring
The time the role was last updated.
updatedByobject
descriptionstring or null
The role's description.

Errors