Audit
Content
Content - attachments
Content body
Content - children and descendants
Content - macro body
Content comments
Content labels
Content permissions
Content properties
Content restrictions
Content versions
Content watches
Dynamic modules
Experimental
Group
Inline tasks
Label info
Long-running task
Relation
Search
Settings
Space
Space permissions
Space properties
Space settings
Template
Themes
Users

Rate this page:

Content permissions

Check content permissions

POST /wiki/rest/api/content/{id}/permission/check

Check if a user or a group can perform an operation to the specified content. The operation to check must be provided. The user’s account ID or the ID of the group can be provided in the subject to check permissions against a specified user or group. The following permission checks are done to make sure that the user or group has the proper access:

  • site permissions
  • space permissions
  • content restrictions

Permissions required: Permission to access the Confluence site ('Can use' global permission) if checking permission for self, otherwise 'Confluence Administrator' global permission is required.

Connect app scope requiredREAD

OAuth scopes required
read:confluence-content.permission

Request

Path parameters
id Required

string

The ID of the content to check permissions against.

Body parameters

This object represents the request for the content permission check API.

subject Required

PermissionSubjectWithGroupId

The user or group that the permission applies to.

operation Required

string

The content permission operation to check.

Valid values: read, update, delete

Example

1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/permission/check' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "subject": {
    "type": "user",
    "identifier": "<string>"
  },
  "operation": "read"
}'

Responses

Returned if the permission check completed successfully

Content typeValue
application/json

PermissionCheckResponse

Rate this page: