Content permissions

Operations

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

POST

Check content permissions

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.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:confluence-content.permission

Granular:read:content.permission:confluence

Connect app scope required: READ

Request

Path parameters

string

Required

Request bodyapplication/json

The content permission request.

subject

PermissionSubjectWithGroupId

Required

operation

string

Required

Responses

Returned if the permission check completed successfully

application/json

PermissionCheckResponse

This object represents the response for the content permission check API. If the user or group does not have permissions, the following errors may be returned:

Group does not have permission to the space
Group does not have permission to the content
User is not allowed to use Confluence
User does not have permission to the space
User does not have permission to the content
Anonymous users are not allowed to use Confluence
Anonymous user does not have permission to the space
Anonymous user does not have permission to the content

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

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": "read"
}`;

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

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

200Response

{
  "hasPermission": true,
  "errors": [
    {
      "translation": "<string>",
      "args": [
        "<string>"
      ]
    }
  ],
  "_links": {}
}