Function: bulkRemoveSpacePermissionAccess()

function bulkRemoveSpacePermissionAccess(client, parameters): Promise<{
[key: string]: unknown;
  status: "FAILED" | "COMPLETED" | "IN_PROGRESS";
  statusUrl: string;
  taskId: string;
}>;

Defined in: src/v2/api/spacePermissionTransition.ts:89

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.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ permissionCombinationIds: string[]; spaceSelection: { [key: string]: unknown; selectedSpaces?: object[] | null; spaceType: | "ALL" | "ALL_EXCEPT_PERSONAL" | "ALL_EXCEPT_SPECIFIC" | "PERSONAL" | "SPECIFIC"; }; }	-
parameters.permissionCombinationIds	string[]	List of permission combination IDs to remove access for.
parameters.spaceSelection	{ [key: string]: unknown; selectedSpaces?: object[] | null; spaceType: | "ALL" | "ALL_EXCEPT_PERSONAL" | "ALL_EXCEPT_SPECIFIC" | "PERSONAL" | "SPECIFIC"; }	-
parameters.spaceSelection.selectedSpaces?	object[] | null	List of specific spaces. Required when spaceType is SPECIFIC or ALL_EXCEPT_SPECIFIC.
parameters.spaceSelection.spaceType	| "ALL" | "ALL_EXCEPT_PERSONAL" | "ALL_EXCEPT_SPECIFIC" | "PERSONAL" | "SPECIFIC"	The space selection type.

Returns

Promise<{ [key: string]: unknown; status: "FAILED" | "COMPLETED" | "IN_PROGRESS"; statusUrl: string; taskId: string; }>