Cloud
Confluence Cloud / Reference / REST API v2

Space Permissions

GET

Get space permissions assignments

Returns space permission assignments for a specific space.

Permissions required: Permission to view the space.

Data Security Policy: Exempt from app access rules
Scopes
read:space:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

Responses

Returned if the requested assignments are returned.

application/json

MultiEntityResult<SpacePermissionAssignment>
GET/spaces/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/spaces/{id}/permissions`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "results": [ { "id": "<string>", "principal": { "type": "user", "id": "<string>" }, "operation": { "key": "use", "targetType": "page" } } ], "_links": { "next": "<string>", "base": "<string>" } }
GET

Get available space permissionsExperimental

Retrieves the available space permissions.

Permissions required: Permission to access the Confluence site.

Data Security Policy: Exempt from app access rules
Scopes
read:space.permission:confluence

Connect app scope requiredREAD

Request

Query parameters

cursor

string

limit

integer

Responses

Returned if the requested space permissions are retrieved.

application/json

MultiEntityResult<SpacePermission>
GET/space-permissions
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/space-permissions`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "results": [ { "id": "<string>", "displayName": "<string>", "description": "<string>", "requiredPermissionIds": [ "<string>" ] } ], "_links": { "next": "<string>", "base": "<string>" } }

Rate this page: