v1
latestOpenAPI 3.0.32026-07-13218142597.2 KBGet available space roles
Retrieves the available space roles.
Available on tenants with Role-Based Access Control.
Permissions required: Permission to access the Confluence site; if requesting a certain space's roles, permission to view the space.
Query parameters
The space ID for which to filter available space roles; if empty, return all available space roles for the tenant.
The space role type to filter results by.
The principal ID to filter results by. 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]
The principal type.
The principal type to filter results by. If specified, a principal-id must also be specified.
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.
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 roles are retrieved.