v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Space Roles

Create a space role

Create a space role.

Available on tenants with Role-Based Access Control.

Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.

post/space-roles

Request body

namestring required

Name of the space role

descriptionstring required

Description for the space role

spacePermissionsstring[] required

The ids of the space permissions associated with the space role. Sample value "read/space"; retrieve ids from responses returned by GET /space-permissions endpoint

Response

Returned if the requested space role is created.

idstring

The identifier for the space role.

type'SYSTEM' | 'CUSTOM'

The role type.

namestring

The name for the space role.

descriptionstring

The description for the space role’s usage.

spacePermissionsstring[]

The space permissions the space role is comprised of.