Sign in
Space Roles

Update a space role

Update 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.

put/space-roles/{id}

Path parameters

idstring required

Id of the space role

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

anonymousReassignmentRoleIdstring

If space anonymous access is assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Anonymous access role assignments left unchanged if unspecified.

guestReassignmentRoleIdstring

If guests are assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Guest role assignments left unchanged if unspecified.

Response

Returned if the update of the space role was accepted.

idstring

Id of the space role

type'SYSTEM' | 'CUSTOM'

The role type.

namestring

Name of the space role

descriptionstring

Description for the space role

taskIdstring

Id of the task to update the space permissions associated with the space role

Changes

No recorded changes to this endpoint across all 2 revisions of this API.