Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
  • Admin Key
  • Attachment
  • App Properties
  • Ancestors
  • Blog Post
  • Children
  • Classification Level
  • Comment
  • Content
  • Content Permissions
  • Content Properties
  • Custom Content
  • Database
  • Data Policies
  • Descendants
  • Folder
  • Label
  • Like
  • Operation
  • Page
  • Redactions
  • Space
  • Space Permissions
  • Space Permission Transition
  • Space Properties
  • Space Roles
  • Task
  • User
  • Version
  • Whiteboard
Cloud
Confluence Cloud / Reference / REST API v2

Content Permissions

Postman Collection
OpenAPI
GET

Get page restriction state

Returns the restriction state of a page.

Permissions required: Permission to view the page.

Data Security Policy: Not exempt from app access rules
Scopes
read:page:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Responses

Returned if the restriction state is successfully retrieved.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

GET/pages/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/pages/{id}/restriction-state`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
PUT

Set page restriction state

Sets the restriction state of a page.

Permissions required: Permission to edit the page or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

state

ContentRestrictionState

Required

Responses

Returned if the state was successfully updated.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

PUT/pages/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "state": "OPEN" }`; const response = await requestConfluence(`/wiki/api/v2/pages/{id}/restriction-state`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
GET

Get blog post restriction state

Returns the restriction state of a blog post.

Permissions required: Permission to view the blog post.

Data Security Policy: Not exempt from app access rules
Scopes
read:page:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Responses

Returned if the restriction state is successfully retrieved.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

GET/blogposts/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/blogposts/{id}/restriction-state`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
PUT

Set blog post restriction state

Sets the restriction state of a blog post.

Permissions required: Permission to edit the blog post or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

state

ContentRestrictionState

Required

Responses

Returned if the state was successfully updated.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

PUT/blogposts/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "state": "OPEN" }`; const response = await requestConfluence(`/wiki/api/v2/blogposts/{id}/restriction-state`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
GET

Get database restriction state

Returns the restriction state of a database.

Permissions required: Permission to view the database.

Data Security Policy: Not exempt from app access rules
Scopes
read:database:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Responses

Returned if the restriction state is successfully retrieved.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

GET/databases/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/databases/{id}/restriction-state`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
PUT

Set database restriction state

Sets the restriction state of a database.

Permissions required: Permission to edit the database or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:database:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

state

ContentRestrictionState

Required

Responses

Returned if the state was successfully updated.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

PUT/databases/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "state": "OPEN" }`; const response = await requestConfluence(`/wiki/api/v2/databases/{id}/restriction-state`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
GET

Get whiteboard restriction state

Returns the restriction state of a whiteboard.

Permissions required: Permission to view the whiteboard.

Data Security Policy: Not exempt from app access rules
Scopes
read:whiteboard:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Responses

Returned if the restriction state is successfully retrieved.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

GET/whiteboards/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/whiteboards/{id}/restriction-state`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
PUT

Set whiteboard restriction state

Sets the restriction state of a whiteboard.

Permissions required: Permission to edit the whiteboard or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:whiteboard:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

state

ContentRestrictionState

Required

Responses

Returned if the state was successfully updated.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

PUT/whiteboards/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "state": "OPEN" }`; const response = await requestConfluence(`/wiki/api/v2/whiteboards/{id}/restriction-state`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
GET

Get folder restriction state

Returns the restriction state of a folder.

Permissions required: Permission to view the folder.

Data Security Policy: Not exempt from app access rules
Scopes
read:folder:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Responses

Returned if the restriction state is successfully retrieved.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

GET/folders/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/folders/{id}/restriction-state`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
PUT

Set folder restriction state

Sets the restriction state of a folder.

Permissions required: Permission to edit the folder or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:folder:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

state

ContentRestrictionState

Required

Responses

Returned if the state was successfully updated.

application/json

RestrictionStateResponse

The direct restriction state of a content item. Inherited restrictions are not included.

PUT/folders/{id}/restriction-state
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "state": "OPEN" }`; const response = await requestConfluence(`/wiki/api/v2/folders/{id}/restriction-state`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 { "state": "OPEN", "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" }
GET

Get page permissions

Returns the direct content permissions on a page with optional filtering by operation, principal-type, and principal-id. Results are cursor-paginated (max 250 per page).

Permissions required: Permission to view the page.

Data Security Policy: Not exempt from app access rules
Scopes
read:page:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

cursor

string

limit

integer

Responses

Returned if the permissions are successfully retrieved.

application/json

MultiEntityResult<ContentPermissionOutput>
GET/pages/{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 { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/pages/{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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
PUT

Set page permissions

Replaces all direct content permissions on a page with the provided set. Any permissions not included in the request body are removed.

Permissions required: Permission to edit the page or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully replaced.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

PUT/pages/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/pages/{id}/permissions`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); 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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
POST

Add page permissions

Adds or replaces direct content permissions for the specified principals on a page. Permissions for other principals are preserved; use PUT to replace all permissions at once.

A principal can hold only one read or update permission. Adding read for a principal that currently has update downgrades that principal to read; adding update upgrades them. If the same request contains both operations for a principal, update takes precedence.

Reasserting a principal's existing permission is idempotent and returns a successful response without creating a duplicate entry.

Permissions required: Permission to edit the page or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully added.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

POST/pages/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/pages/{id}/permissions`, { 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
DEL

Delete page permissions

Deletes direct content permissions from a page. Filters narrow the deletion scope; omitting all filters deletes all direct permissions.

The following filter combinations are supported:

  • No filters: deletes all direct permissions.
  • principal-type + principal-id: deletes the principal's direct read or update permission.
  • operation + principal-type + principal-id: deletes the permission only when its operation matches.

Providing operation without principal-type/principal-id, or providing only one of principal-type/principal-id, returns a 400 error.

Permissions required: Permission to edit the page or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

allow-self-lockout

boolean

Responses

Returned if the permissions are successfully deleted.

DEL/pages/{id}/permissions
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/pages/{id}/permissions`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get blog post permissions

Returns the direct content permissions on a blog post with optional filtering by operation, principal-type, and principal-id. Results are cursor-paginated (max 250 per page).

Permissions required: Permission to view the blog post.

Data Security Policy: Not exempt from app access rules
Scopes
read:page:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

cursor

string

limit

integer

Responses

Returned if the permissions are successfully retrieved.

application/json

MultiEntityResult<ContentPermissionOutput>
GET/blogposts/{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 { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/blogposts/{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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
PUT

Set blog post permissions

Replaces all direct content permissions on a blog post with the provided set. Any permissions not included in the request body are removed.

Permissions required: Permission to edit the blog post or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully replaced.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

PUT/blogposts/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/blogposts/{id}/permissions`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); 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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
POST

Add blog post permissions

Adds or replaces direct content permissions for the specified principals on a blog post. Permissions for other principals are preserved; use PUT to replace all permissions at once.

A principal can hold only one read or update permission. Adding read for a principal that currently has update downgrades that principal to read; adding update upgrades them. If the same request contains both operations for a principal, update takes precedence.

Reasserting a principal's existing permission is idempotent and returns a successful response without creating a duplicate entry.

Permissions required: Permission to edit the blog post or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully added.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

POST/blogposts/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/blogposts/{id}/permissions`, { 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
DEL

Delete blog post permissions

Deletes direct content permissions from a blog post. See DELETE /pages/{id}/permissions for filter semantics.

Permissions required: Permission to edit the blog post or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

allow-self-lockout

boolean

Responses

Returned if the permissions are successfully deleted.

DEL/blogposts/{id}/permissions
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/blogposts/{id}/permissions`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get database permissions

Returns the direct content permissions on a database with optional filtering. Results are cursor-paginated (max 250 per page).

Permissions required: Permission to view the database.

Data Security Policy: Not exempt from app access rules
Scopes
read:database:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

cursor

string

limit

integer

Responses

Returned if the permissions are successfully retrieved.

application/json

MultiEntityResult<ContentPermissionOutput>
GET/databases/{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 { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/databases/{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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
PUT

Set database permissions

Replaces all direct content permissions on a database with the provided set.

Permissions required: Permission to edit the database or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:database:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully replaced.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

PUT/databases/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/databases/{id}/permissions`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); 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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
POST

Add database permissions

Adds or replaces direct content permissions for the specified principals on a database. Permissions for other principals are preserved; use PUT to replace all permissions at once.

A principal can hold only one read or update permission. Adding read for a principal that currently has update downgrades that principal to read; adding update upgrades them. If the same request contains both operations for a principal, update takes precedence.

Reasserting a principal's existing permission is idempotent and returns a successful response without creating a duplicate entry.

Permissions required: Permission to edit the database or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:database:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully added.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

POST/databases/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/databases/{id}/permissions`, { 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
DEL

Delete database permissions

Deletes direct content permissions from a database. See DELETE /pages/{id}/permissions for filter semantics.

Permissions required: Permission to edit the database or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:database:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

allow-self-lockout

boolean

Responses

Returned if the permissions are successfully deleted.

DEL/databases/{id}/permissions
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/databases/{id}/permissions`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get whiteboard permissions

Returns the direct content permissions on a whiteboard with optional filtering. Results are cursor-paginated (max 250 per page).

Permissions required: Permission to view the whiteboard.

Data Security Policy: Not exempt from app access rules
Scopes
read:whiteboard:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

cursor

string

limit

integer

Responses

Returned if the permissions are successfully retrieved.

application/json

MultiEntityResult<ContentPermissionOutput>
GET/whiteboards/{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 { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/whiteboards/{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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
PUT

Set whiteboard permissions

Replaces all direct content permissions on a whiteboard with the provided set.

Permissions required: Permission to edit the whiteboard or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:whiteboard:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully replaced.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

PUT/whiteboards/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/whiteboards/{id}/permissions`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); 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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
POST

Add whiteboard permissions

Adds or replaces direct content permissions for the specified principals on a whiteboard. Permissions for other principals are preserved; use PUT to replace all permissions at once.

A principal can hold only one read or update permission. Adding read for a principal that currently has update downgrades that principal to read; adding update upgrades them. If the same request contains both operations for a principal, update takes precedence.

Reasserting a principal's existing permission is idempotent and returns a successful response without creating a duplicate entry.

Permissions required: Permission to edit the whiteboard or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:whiteboard:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully added.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

POST/whiteboards/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/whiteboards/{id}/permissions`, { 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
DEL

Delete whiteboard permissions

Deletes direct content permissions from a whiteboard. See DELETE /pages/{id}/permissions for filter semantics.

Permissions required: Permission to edit the whiteboard or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:whiteboard:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

allow-self-lockout

boolean

Responses

Returned if the permissions are successfully deleted.

DEL/whiteboards/{id}/permissions
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/whiteboards/{id}/permissions`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
GET

Get folder permissions

Returns the direct content permissions on a folder with optional filtering. Results are cursor-paginated (max 250 per page).

Permissions required: Permission to view the folder.

Data Security Policy: Not exempt from app access rules
Scopes
read:folder:confluence

Connect app scope required: READ

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

cursor

string

limit

integer

Responses

Returned if the permissions are successfully retrieved.

application/json

MultiEntityResult<ContentPermissionOutput>
GET/folders/{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 { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/folders/{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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
PUT

Set folder permissions

Replaces all direct content permissions on a folder with the provided set.

Permissions required: Permission to edit the folder or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:folder:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully replaced.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

PUT/folders/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/folders/{id}/permissions`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); 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 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
POST

Add folder permissions

Adds or replaces direct content permissions for the specified principals on a folder. Permissions for other principals are preserved; use PUT to replace all permissions at once.

A principal can hold only one read or update permission. Adding read for a principal that currently has update downgrades that principal to read; adding update upgrades them. If the same request contains both operations for a principal, update takes precedence.

Reasserting a principal's existing permission is idempotent and returns a successful response without creating a duplicate entry.

Permissions required: Permission to edit the folder or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:folder:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

allow-self-lockout

boolean

Request bodyapplication/json

permissions

array<OperationPermissionsInput>

Required

Responses

Returned if the permissions are successfully added.

application/json

ContentPermissionsResponse

Contains up to 250 direct permissions on a content item. GET responses support cursor pagination to retrieve additional entries.

POST and PUT responses contain only the first 250 permissions from the resulting direct-permission set. Use the corresponding GET permissions endpoint to retrieve any remaining entries.

POST/folders/{id}/permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{ "permissions": [ { "operation": "read", "principals": [ { "principalType": "user", "principalId": "<string>" } ] } ] }`; const response = await requestConfluence(`/wiki/api/v2/folders/{id}/permissions`, { 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "results": [ { "operation": "read", "principal": { "principalType": "user", "principalId": "<string>" }, "createdAt": "<string>", "createdBy": "<string>", "createdByAaid": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
DEL

Delete folder permissions

Deletes direct content permissions from a folder. See DELETE /pages/{id}/permissions for filter semantics.

Permissions required: Permission to edit the folder or administer the space.

Data Security Policy: Not exempt from app access rules
Scopes
write:folder:confluence

Connect app scope required: WRITE

Request

Path parameters

id

integer

Required

Query parameters

operation

string

principal-type

string

principal-id

string

allow-self-lockout

boolean

Responses

Returned if the permissions are successfully deleted.

DEL/folders/{id}/permissions
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; const response = await requestConfluence(`/wiki/api/v2/folders/{id}/permissions`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: