The Confluence Cloud REST API

Space permissions

Add new permission to space

POST /wiki/rest/api/space/{spaceKey}/permission

Adds new permission to space.

If the permission to be added is a group permission, the group can be identified by its group name or group id.

Note: Apps cannot access this REST resource - including when utilizing user impersonation.

Permissions required: 'Admin' permission for the space.

Connect apps cannot access this REST resource.

OAuth 2.0 scopes required:

read:space.permission:confluence, write:space.permission:confluence

Request

Path parameters

spaceKey Required

string

The key of the space to be queried for its content.

Body parameters

This object represents the request for the single space permission. Permissions consist of at least one operation object with an accompanying subjects object.

The following combinations of operation.key and operation.target values are valid for the operation object:

1
2
'create': 'page', 'blogpost', 'comment', 'attachment'
'read': 'space'
'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'
'export': 'space'
'administer': 'space'
'archive': 'page'
'restrict_content': 'space'

For example, to enable Delete Own permission, set the operation object to the following:

1
2
"operation": {
    "key": "delete",
    "target": "space"
}

To enable Add/Delete Restrictions permissions, set the operation object to the following:

1
2
"operation": {
    "key": "restrict_content",
    "target": "space"
}

subject Required

PermissionSubject

The user or group that the permission applies to.

operation Required

object

_links

GenericLinks

Additional Properties

anything

Extra properties of any type may be provided to this object.

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "subject": {
    "type": "user",
    "identifier": "<string>"
  },
  "operation": {
    "key": "administer",
    "target": "page"
  },
  "_links": {}
}`;

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/permission`, {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

400

401

403

404

Returned if the requested content is returned.

Content type	Value
application/json	SpacePermissionV2

Add new custom content permission to space

POST /wiki/rest/api/space/{spaceKey}/permission/custom-content

Adds new custom content permission to space.

If the permission to be added is a group permission, the group can be identified by its group name or group id.

Note: Only apps can access this REST resource and only make changes to the respective app permissions.

Permissions required: 'Admin' permission for the space.

Connect app scope required: WRITE

OAuth 2.0 scopes required:

read:space.permission:confluence, write:space.permission:confluence

Request

Path parameters

spaceKey Required

string

The key of the space to be queried for its content.

Body parameters

This object represents a list of space permissions for custom content type for an individual user. Permissions consist of a subjects object and a list with at least one operation object.

subject Required

PermissionSubject

The user or group that the permission applies to.

operations Required

Array<object>

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "subject": {
    "type": "user",
    "identifier": "<string>"
  },
  "operations": [
    {
      "key": "read",
      "target": "<string>",
      "access": true
    }
  ]
}`;

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/permission/custom-content`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

200

400

401

403

404

Returned if the requested content is returned.

A schema has not been defined for this response code.

Remove a space permission

DELETE /wiki/rest/api/space/{spaceKey}/permission/{id}

Removes a space permission. Note that removing Read Space permission for a user or group will remove all the space permissions for that user or group.

Note: Apps cannot access this REST resource - including when utilizing user impersonation.

Permissions required: 'Admin' permission for the space.

Connect apps cannot access this REST resource.

OAuth 2.0 scopes required:

write:space.permission:confluence

Request

Path parameters

spaceKey Required

string

The key of the space to be queried for its content.

id Required

integer

Id of the permission to be deleted.

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/permission/{id}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

204

400

401

403

404

Permission successfully removed.

A schema has not been defined for this response code.