• Access Mode
  • Admin Group
  • Admin User
  • Attachments
  • Backup and Restore
  • Child Content
  • Content Blueprint
  • Content Body
  • Content Descendant
  • Content Labels
  • Content Property
  • Content Resource
  • Content Restrictions
  • Content Version
  • Content Watchers
  • Group
  • Long Task
  • Space
  • Space Label
  • Space Property
  • Space Watchers
  • User
  • User Group
  • User Watch
  • Webhooks
  • Other operations
Server
Confluence Data Center / / REST API

User

Postman Collection
OpenAPI
POST

Change password

Change the password for the current user.

Validation Rules:

  • New password supplied cannot be null or blank

Example request URI(s):

http://example.com/confluence/rest/api/user/current/password

Request

Request bodyapplication/json

password change details

oldPassword

string

newPassword

string

Responses

returned if the password changed successfully.

POST/rest/api/user/current/password
1 2 3 4 5 6 7 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/user/current/password' \ --header 'Content-Type: application/json' \ --data '{ "oldPassword": "oldPassword", "newPassword": "newPassword" }'
GET

Get information about anonymous user type

Get information about how anonymous is represented in Confluence. Example request URI(s):

http://example.com/confluence/rest/api/user/anonymous

Request

Query parameters

expand

string

Responses

Returns a full JSON representation of a user.

application/json

Person
GET/rest/api/user/anonymous
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/user/anonymous' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "profilePicture": { "path": "http://www.example.com/path/to/image.png", "width": 16, "height": 16, "isDefault": true }, "displayName": "Joe Smith", "type": "<string>" }
GET

Get current user

Get information about the current logged in user. Example request URI(s):

http://example.com/confluence/rest/api/user/current

Request

Query parameters

expand

string

Responses

Returns a full JSON representation of a user.

application/json

Person
GET/rest/api/user/current
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/user/current' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "profilePicture": { "path": "http://www.example.com/path/to/image.png", "width": 16, "height": 16, "isDefault": true }, "displayName": "Joe Smith", "type": "<string>" }
GET

Get groups

Get a paginated collection of groups that the given user is a member of. Example request URI(s):

http://example.com/confluence/rest/api/user/memberof?username=jblogs http://example.com/confluence/rest/api/user/memberof?key=402880824ff933a4014ff9345d7c0002

Request

Query parameters

expand

string

limit

string

start

string

key

string

username

string

Responses

Returns a full JSON representation of a user.

application/json

object
GET/rest/api/user/memberof
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/user/memberof' \ --header 'Accept: application/json'
200Response
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 { "pageRequest": { "cursor": { "reverse": true, "cursorType": "SPACE" }, "start": 2154, "limit": 2154 }, "nextCursor": { "reverse": true, "cursorType": "SPACE" }, "prevCursor": { "reverse": true, "cursorType": "SPACE" }, "results": [ { "profilePicture": { "path": "http://www.example.com/path/to/image.png", "width": 16, "height": 16, "isDefault": true }, "displayName": "Joe Smith", "type": "<string>" } ], "start": 25, "limit": 25, "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" }
GET

Get user

Get information about a user identified by either user key or username. Example request URI(s):

http://example.com/confluence/rest/api/user?username=jblogs http://example.com/confluence/rest/api/user?key=402880824ff933a4014ff9345d7c0002

Request

Query parameters

expand

string

key

string

username

string

Responses

Returns a full JSON representation of a user

application/json

Person
GET/rest/api/user
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/user' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "profilePicture": { "path": "http://www.example.com/path/to/image.png", "width": 16, "height": 16, "isDefault": true }, "displayName": "Joe Smith", "type": "<string>" }
GET

Get registered users

Gets a paginated collection of all registered users, including but not limited to:

  • Disabled users
  • Enabled users
  • Enabled users which count towards the license count on the site
  • Enabled users which do not count towards the license count on the site
  • Enabled users which have "can use" global permissions
  • Enabled users which do not have "can use" global permissions

Example request URI(s):

http://example.com/confluence/rest/api/user/list http://example.com/confluence/rest/api/user/list?start=0 http://example.com/confluence/rest/api/user/list?start=0&limit=100 http://example.com/confluence/rest/api/user/list?start=0&limit=100&expand=status

Request

Query parameters

expand

string

limit

string

start

string

Responses

returns a paginated collection of users.

application/json

object
GET/rest/api/user/list
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/user/list' \ --header 'Accept: application/json'
200Response
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 { "pageRequest": { "cursor": { "reverse": true, "cursorType": "SPACE" }, "start": 2154, "limit": 2154 }, "nextCursor": { "reverse": true, "cursorType": "SPACE" }, "prevCursor": { "reverse": true, "cursorType": "SPACE" }, "results": [ { "profilePicture": { "path": "http://www.example.com/path/to/image.png", "width": 16, "height": 16, "isDefault": true }, "displayName": "Joe Smith", "type": "<string>" } ], "start": 25, "limit": 25, "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" }

Rate this page: