space-roles

create-space-role

Create a space role

Create a space role.

Available as part of the Role-Based Access Controls Beta.

Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.

POST /space-roles

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

Example:

cf space-roles create-space-role

delete-space-role

Delete a space role

Delete a space role

Available as part of the Role-Based Access Controls Beta.

Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.

DELETE /space-roles/{id}

Flag	Type	Required	Description
--id	string	Yes	Id of the space role

Example:

cf space-roles delete-space-role --id <id>

get-available-space-roles

Get available space roles

Retrieves the available space roles.

Available as part of the Role-Based Access Controls Beta.

Permissions required: Permission to access the Confluence site; if requesting a certain space's roles, permission to view the space.

GET /space-roles

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 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.
--principal-id	string	No	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]
--principal-type	string	No	The principal type to filter results by. If specified, a principal-id must also be specified.
--role-type	string	No	The space role type to filter results by.
--space-id	string	No	The space ID for which to filter available space roles; if empty, return all available space roles for the tenant.

Example:

cf space-roles get-available-space-roles

get-space-roles-by-id

Get space role by ID

Retrieves the space role by ID.

Available as part of the Role-Based Access Controls Beta.

Permissions required: Permission to access the Confluence site.

GET /space-roles/{id}

Flag	Type	Required	Description
--id	string	Yes	The ID of the space role to retrieve.

Example:

cf space-roles get-space-roles-by-id --id <id>

update-space-role

Update a space role

Update a space role.

Available as part of the Role-Based Access Controls Beta.

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}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	Id of the space role

Example:

cf space-roles update-space-role --id <id>