Gets a paginated collection of all active users (users which count into license usage). This will exclude users that are:
This feature relies on search index and might not be accurate when site reindex is in progress.
Example request URI(s):
http://example.com/confluence/rest/api/admin/users/list/active
http://example.com/confluence/rest/api/admin/users/list/active?start=0
http://example.com/confluence/rest/api/admin/users/list/active?start=0&limit=100
http://example.com/confluence/rest/api/admin/users/list/active?start=0&limit=100&expand=status
Forge and OAuth2 apps cannot access this REST resource.
string
string
string
returns a paginated collection of users.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/admin/users/list/active' \
--header 'Accept: application/json'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
{
"totalCount": 2154,
"results": [
{
"profilePicture": {
"path": "http://www.example.com/path/to/image.png",
"width": 16,
"height": 16,
"isDefault": true
},
"displayName": "Joe Smith",
"type": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Rate this page: