Creates a new role.

POST

Creates a new role.

Required Permissions: The user must be an admin or have workspace-manage-config:write permissions.

Request

This endpoint expects an object.
namestringRequired>=1 character

The name of the role. Must be unique.

isAdminRolebooleanOptionalDefaults to false

Whether this is the admin role. Only one role can be the admin role.

isGuestRolebooleanOptionalDefaults to false

Whether this is the guest role. Only one role can be the guest role.

Response

OK

namestring>=1 character

The name of the role. Must be unique.

isAdminRolebooleanOptionalDefaults to false

Whether this is the admin role. Only one role can be the admin role.

isGuestRolebooleanOptionalDefaults to false

Whether this is the guest role. Only one role can be the guest role.

idstringOptional

The id of the role.

isPresetbooleanOptionalDefaults to false

Whether this role is one of the preset roles. Preset roles can be edited, archived and deleted.

isArchivedbooleanOptionalDefaults to false

Whether the role has been archived.

createdBystringOptional

The id of the user who created this role.

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this role was created.

updatedBystringOptional

The id of the user who updated this role.

updatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this role was last modified.

Built with