Returns the restriction state of a page.
Permissions required: Permission to view the page.
read:page:confluenceConnect app scope required: READ
integer
RequiredReturned if the restriction state is successfully retrieved.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Sets the restriction state of a page.
Permissions required: Permission to edit the page or administer the space.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredboolean
ContentRestrictionState
RequiredReturned if the state was successfully updated.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Returns the restriction state of a blog post.
Permissions required: Permission to view the blog post.
read:page:confluenceConnect app scope required: READ
integer
RequiredReturned if the restriction state is successfully retrieved.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Sets the restriction state of a blog post.
Permissions required: Permission to edit the blog post or administer the space.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredboolean
ContentRestrictionState
RequiredReturned if the state was successfully updated.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Returns the restriction state of a database.
Permissions required: Permission to view the database.
read:database:confluenceConnect app scope required: READ
integer
RequiredReturned if the restriction state is successfully retrieved.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Sets the restriction state of a database.
Permissions required: Permission to edit the database or administer the space.
write:database:confluenceConnect app scope required: WRITE
integer
Requiredboolean
ContentRestrictionState
RequiredReturned if the state was successfully updated.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Returns the restriction state of a whiteboard.
Permissions required: Permission to view the whiteboard.
read:whiteboard:confluenceConnect app scope required: READ
integer
RequiredReturned if the restriction state is successfully retrieved.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Sets the restriction state of a whiteboard.
Permissions required: Permission to edit the whiteboard or administer the space.
write:whiteboard:confluenceConnect app scope required: WRITE
integer
Requiredboolean
ContentRestrictionState
RequiredReturned if the state was successfully updated.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Returns the restriction state of a folder.
Permissions required: Permission to view the folder.
read:folder:confluenceConnect app scope required: READ
integer
RequiredReturned if the restriction state is successfully retrieved.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}Sets the restriction state of a folder.
Permissions required: Permission to edit the folder or administer the space.
write:folder:confluenceConnect app scope required: WRITE
integer
Requiredboolean
ContentRestrictionState
RequiredReturned if the state was successfully updated.
The direct restriction state of a content item. Inherited restrictions are not included.
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());1
2
3
4
5
6
{
"state": "OPEN",
"createdAt": "<string>",
"createdBy": "<string>",
"createdByAaid": "<string>"
}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.
read:page:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
string
integer
Returned if the permissions are successfully retrieved.
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());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>"
}
}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.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully replaced.
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.
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());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>"
}
}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.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully added.
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.
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());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>"
}
}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:
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.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredstring
string
string
boolean
Returned if the permissions are successfully deleted.
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());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.
read:page:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
string
integer
Returned if the permissions are successfully retrieved.
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());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>"
}
}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.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully replaced.
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.
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());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>"
}
}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.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully added.
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.
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());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>"
}
}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.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredstring
string
string
boolean
Returned if the permissions are successfully deleted.
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());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.
read:database:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
string
integer
Returned if the permissions are successfully retrieved.
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());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>"
}
}Replaces all direct content permissions on a database with the provided set.
Permissions required: Permission to edit the database or administer the space.
write:database:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully replaced.
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.
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());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>"
}
}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.
write:database:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully added.
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.
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());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>"
}
}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.
write:database:confluenceConnect app scope required: WRITE
integer
Requiredstring
string
string
boolean
Returned if the permissions are successfully deleted.
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());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.
read:whiteboard:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
string
integer
Returned if the permissions are successfully retrieved.
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());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>"
}
}Replaces all direct content permissions on a whiteboard with the provided set.
Permissions required: Permission to edit the whiteboard or administer the space.
write:whiteboard:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully replaced.
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.
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());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>"
}
}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.
write:whiteboard:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully added.
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.
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());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>"
}
}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.
write:whiteboard:confluenceConnect app scope required: WRITE
integer
Requiredstring
string
string
boolean
Returned if the permissions are successfully deleted.
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());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.
read:folder:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
string
integer
Returned if the permissions are successfully retrieved.
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());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>"
}
}Replaces all direct content permissions on a folder with the provided set.
Permissions required: Permission to edit the folder or administer the space.
write:folder:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully replaced.
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.
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());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>"
}
}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.
write:folder:confluenceConnect app scope required: WRITE
integer
Requiredboolean
array<OperationPermissionsInput>
RequiredReturned if the permissions are successfully added.
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.
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());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>"
}
}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.
write:folder:confluenceConnect app scope required: WRITE
integer
Requiredstring
string
string
boolean
Returned if the permissions are successfully deleted.
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: