v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Space Roles

Get space role assignments

Retrieves the space role assignments.

Available on tenants with Role-Based Access Control.

Permissions required: Permission to view the space.

get/spaces/{id}/role-assignments

Path parameters

idinteger required

The ID of the space for which to retrieve assignments.

Query parameters

role-idstring

Filters the returned role assignments to the provided role ID.

role-typestring

Filters the returned role assignments to the provided role type.

principal-idstring

Filters the returned role assignments to the provided principal id. If specified, a principal-type must also be specified. Paired with a principal-type of ACCESS_CLASS, valid values include [anonymous-users, jsm-project-admins, authenticated-users, all-licensed-users, all-product-admins]

principal-type'USER' | 'GROUP' | 'ACCESS_CLASS'

The principal type.

Filters the returned role assignments to the provided principal type. If specified, a principal-id must also be specified.

cursorstring

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limitinteger

Maximum number of space roles to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.

Response

Returned if the requested space role assignments are retrieved.