Returns list of permissions granted to users and groups.
Example request URI's:
1`https://example.com/confluence/rest/api/permissions`
This request has no parameters.
Returns a JSON representation of all global permissions granted to users/groups/anonymous user.
array<GlobalPermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/permissions' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
}
}
]Sets global permissions to multiple users/groups.
Request should contain all permissions that users/groups will have.
If permission is absent in the request, but was granted before, it will be revoked.
If empty list of permissions passed to users/groups, then all their existing permissions will be revoked.
If users/groups not mentioned in the request, their permissions will not be revoked.
Maximum 40 different users/groups could be passed in the request by default .
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
See Global Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/permissions
array<SpacePermissionsForSubject>
string
string
array<OperationDescription>
Global permissions successfully set.
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
30
31
32
33
34
35
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions' \
--header 'Content-Type: application/json' \
--data '[
{
"userKey": "4028ae289154667d0191546e11a10001",
"operations": [
{
"operationKey": "create",
"targetType": "space"
},
{
"operationKey": "use",
"targetType": "application"
}
]
},
{
"groupName": "group1",
"operations": [
{
"operationKey": "create",
"targetType": "personal_space"
},
{
"operationKey": "use",
"targetType": "application"
},
{
"operationKey": "administer",
"targetType": "application"
}
]
}
]'Returns list of permissions granted to anonymous user.
Example request URI's:
1`https://example.com/confluence/rest/api/permissions/anonymous`
This request has no parameters.
Returns a JSON representation of the permissions granted to the group.
array<GlobalPermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/permissions/anonymous' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
}
}
]Returns list of permissions granted to group.
Example request URI's:
1`https://example.com/confluence/rest/api/permissions/group/{groupName}}`
string
RequiredReturns a JSON representation of the permissions granted to the group.
array<GlobalPermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/permissions/group/{groupName}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
}
}
]Returns list of permissions granted to unlicensed users.
Example request URI's:
1`https://example.com/confluence/rest/api/permissions/unlicensed`
This request has no parameters.
Returns a JSON representation of the permissions granted to the group.
array<GlobalPermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/permissions/unlicensed' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
}
}
]Returns list of permissions granted to user.
Example request URI's:
1 2 3with userKey: `https://example.com/confluence/rest/api/permissions/user/{userKey}` with username: `https://example.com/confluence/rest/api/permissions/user/{username}`
string
RequiredReturns a JSON representation of the permissions granted to the user.
array<GlobalPermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/permissions/user/{user}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
}
}
]Grant global permissions to anonymous users.
Operation doesn't override existing permissions, will only add those one that weren't granted before.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
Example request URI's:
1`https://example.com/confluence/rest/api/permissions/anonymous/grant`
array<OperationDescription>
string
string
Global permissions successfully granted to anonymous users.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/anonymous/grant' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Grant global permissions to a group.
Operation doesn't override existing permissions, will only add those one that weren't granted before.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
See Global Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/permissions/group/test-group-name/grant
string
Requiredarray<OperationDescription>
string
string
Global permissions successfully granted to a group.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/group/{groupName}/grant' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Grant global permissions to unlicensed users.
Operation doesn't override existing permissions, will only add those one that weren't granted before.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
Example request URI's:
1`https://example.com/confluence/rest/api/permissions/unlicensed/grant`
array<OperationDescription>
string
string
Global permissions successfully granted to unlicensed users.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/unlicensed/grant' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Grant global permissions to a user.
Operation doesn't override existing permissions, will only add those one that weren't granted before.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
Example request URI's:
with userKey: https://example.com/confluence/rest/api/permissions/user/{userKey}/grant
with username: https://example.com/confluence/rest/api/permissions/user/{username}/grant
string
Requiredarray<OperationDescription>
string
string
Global permissions successfully granted to a user.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/user/{user}/grant' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Revoke global permissions from anonymous users.
When 'application use' is revoked, all granted permissions will be removed from anonymous users.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
Example request URI's:
1`https://example.com/confluence/rest/api/permissions/anonymous/revoke`
array<OperationDescription>
string
string
Global permissions successfully revoked from anonymous users.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/anonymous/revoke' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Revoke global permissions from a group.
When 'application use' is revoked, all granted permissions will be removed from target group.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
See Global Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/permissions/group/test-group-name/revoke
string
Requiredarray<OperationDescription>
string
string
Global permissions successfully revoked from a group.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/group/{groupName}/revoke' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Revoke global permissions from unlicensed users.
When 'application use_unlicensed' is revoked, all granted permissions will be removed from unlicensed users.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
Example request URI's:
1`https://example.com/confluence/rest/api/permissions/unlicensed/revoke`
array<OperationDescription>
string
string
Global permissions successfully revoked from unlicensed users.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/unlicensed/revoke' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Revoke global permissions from a user.
When 'application use' is revoked, all granted permissions will be removed from target user.
Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
See Global Permissions documentation for additional information about supported permissions.
Example request URI's:
with userKey: https://example.com/confluence/rest/api/permissions/user/{userKey}/revoke
with username: https://example.com/confluence/rest/api/permissions/user/{username}/revoke
string
Requiredarray<OperationDescription>
string
string
Global permissions successfully revoked from a user.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/permissions/user/{user}/revoke' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
}
]'Rate this page: