Returns list of permissions granted to users and groups in the particular space.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions
string
RequiredReturns a JSON representation of all permissions granted to users/groups/anonymous user in specified space.
array<SpacePermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
},
"spaceKey": "<string>",
"spaceId": 2154
}
]Sets permissions to multiple users/groups in the given space. Request should contain all permissions that user/group/anonymous user will have in a given space. If permission is absent in the request, but was granted before, it will be revoked. If empty list of permissions passed to user/group/anonymous user, then all their existing permissions will be revoked. If user/group/anonymous user not mentioned in the request, their permissions will not be revoked.
Maximum 40 different users/groups/anonymous user could be passed in the request.
See Space Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions
string
Requiredarray<SpacePermissionsForSubject>
string
string
array<OperationDescription>
Space permissions successfully set.
any
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
36
37
38
39
40
curl --request POST \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
{
"userKey": "4028ae289154667d0191546e11a10001",
"operations": [
{
"operationKey": "read",
"targetType": "space"
},
{
"operationKey": "administer",
"targetType": "space"
}
]
},
{
"groupName": "group1",
"operations": [
{
"operationKey": "read",
"targetType": "space"
},
{
"operationKey": "create",
"targetType": "comment"
}
]
},
{
"operations": [
{
"operationKey": "read",
"targetType": "space"
}
]
}
]'Returns list of permissions granted to anonymous user in the particular space.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/anonymous
string
RequiredReturns a JSON representation of the space permissions granted to the anonymous user.
array<SpacePermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/anonymous' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
},
"spaceKey": "<string>",
"spaceId": 2154
}
]Returns list of permissions granted to a group in the particular space.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/group/test-group-name
string
Requiredstring
RequiredReturns a JSON representation of the space permissions granted to the group.
array<SpacePermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/group/{groupName}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
},
"spaceKey": "<string>",
"spaceId": 2154
}
]Returns list of permissions granted to user in the particular space.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/user/4028ae289154667d0191546bd5840000
string
Requiredstring
RequiredReturns a JSON representation of the space permissions granted to the user.
array<SpacePermission>
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/user/{userKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
{
"operation": {
"targetType": "space",
"operationKey": "read"
},
"subject": {
"displayName": "<string>",
"type": "<string>"
},
"spaceKey": "<string>",
"spaceId": 2154
}
]Grant permissions to anonymous user in the given space. 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 Space Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/anonymous/grant
string
Requiredarray<OperationDescription>
string
string
Space permissions successfully granted to anonymous user.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/anonymous/grant' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
},
{
"targetType": "page",
"operationKey": "create"
}
]'Grant permissions to a group in the given space. 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 Space Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/group/test-group-name/grant
string
Requiredstring
Requiredarray<OperationDescription>
string
string
Space permissions successfully granted to a group.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/group/{groupName}/grant' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
},
{
"targetType": "page",
"operationKey": "create"
}
]'Grant permissions to a user in the given space. 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 Space Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/user/4028ae289154667d0191546bd5840000/grant
string
Requiredstring
Requiredarray<OperationDescription>
string
string
Space permissions successfully granted to a user.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/user/{userKey}/grant' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "space",
"operationKey": "read"
},
{
"targetType": "page",
"operationKey": "create"
}
]'Revoke permissions from anonymous user in the given space. If anonymous user doesn't have permissions that we are trying to revoke, those permissions will be silently skipped. Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
See Space Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/anonymous/revoke
string
Requiredarray<OperationDescription>
string
string
Space permissions successfully removed for anonymous user.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/anonymous/revoke' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "page",
"operationKey": "delete"
},
{
"targetType": "page",
"operationKey": "create"
}
]'Revoke permissions from a group in the given space. If group doesn't have permissions that we are trying to revoke, those permissions will be silently skipped. Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
See Space Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/group/test-group-name/revoke
string
Requiredstring
Requiredarray<OperationDescription>
string
string
Space permissions successfully removed for a group.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/group/{groupName}/revoke' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "page",
"operationKey": "delete"
},
{
"targetType": "page",
"operationKey": "create"
}
]'Revoke permissions from a user in the given space. If user doesn't have permissions that we are trying to revoke, those permissions will be silently skipped. Multiple permissions could be passed in one request. Supported targetType and operationKey pairs:
See Space Permissions documentation for additional information about supported permissions.
Example request URI's:
https://example.com/confluence/rest/api/space/TESTSPACE/permissions/user/4028ae289154667d0191546bd5840000/revoke
string
Requiredstring
Requiredarray<OperationDescription>
string
string
Space permissions successfully removed for a user.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/permissions/user/{userKey}/revoke' \
--header 'Content-Type: application/json' \
--data '[
{
"targetType": "page",
"operationKey": "delete"
},
{
"targetType": "page",
"operationKey": "create"
}
]'Rate this page: