space-permissions

bulk-assign-space-permission-roles

Bulk assign space permission roles

Bulk assigns roles for one or more permission combination IDs obtained from the space permission combinations. Supports targeting all spaces, specific spaces, or excluding specific spaces.

Permissions required: User must be a Confluence administrator.

POST /space-permissions/transition/role-assignments

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

cf space-permissions bulk-assign-space-permission-roles

bulk-remove-space-permission-access

Bulk remove space permission access

Bulk removes access for one or more permission combination IDs obtained from the space permission combinations. This removes all space permissions for the specified combinations across the targeted spaces.

Permissions required: User must be a Confluence administrator.

POST /space-permissions/transition/access-removals

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

cf space-permissions bulk-remove-space-permission-access

generate-space-permission-combinations

Generate space permission combinations

Submits a task to refresh the space permission combinations in the database, which identifies all unique permission combinations across the site. This provides permission combination IDs that can be used with the assign-roles and remove-access endpoints.

Permissions required: User must be a Confluence administrator.

POST /space-permissions/transition/combinations

Example:

cf space-permissions generate-space-permission-combinations

get-available-space-permissions

Get available space permissions

Retrieves the available space permissions.

Available on tenants with Role-Based Access Control.

Permissions required: Permission to access the Confluence site.

GET /space-permissions

Flag	Type	Required	Description
--cursor	string	No	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.
--limit	string	No	Maximum number of space permissions to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.

Example:

cf space-permissions get-available-space-permissions

get-space-permission-transition-task-status

Get space permission transition task status

Retrieves the status of an async space permission transition task. Use the taskId returned from the generate-combinations, assign-roles, or remove-access endpoints to poll for progress and completion.

Permissions required: User must be a Confluence administrator.

GET /space-permissions/transition/tasks/{taskId}

Flag	Type	Required	Description
--taskId	string	Yes	The ID of the async task, as returned by the generate-combinations, assign-roles, or remove-access endpoints.

Example:

cf space-permissions get-space-permission-transition-task-status --taskId <taskId>

list-space-permission-combinations

List unassigned space permission combinations

Lists the unique unassigned space permission combinations currently present on the tenant. Combinations that already map to a space role are filtered out server-side. Each row carries the decoded set of space permissions and the principal types that currently hold the combination — these inform which principalType values are valid to include in the matching bulk role-assignments request.

Results are always sorted by principalCount descending. Sort field and sort order are not configurable; page size is controlled by the limit query parameter (default 25, min 1, max 250). Use the cursor field to page through additional results. The generatedAt field reflects the last audit run that populated the combinations table — call the generate-combinations endpoint to refresh stale data.

Permissions required: User must be a Confluence administrator.

GET /space-permissions/transition/combinations

Flag	Type	Required	Description
--cursor	string	No	Opaque cursor returned from a previous page in the cursor field of the response. Omit for the first page.
--limit	string	No	The maximum number of combinations to return per page. Requests outside the supported range return 400.

Example:

cf space-permissions list-space-permission-combinations