Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Confluence Data Center / / REST API

User

Operations

POST/rest/api/user/current/password GET/rest/api/user/anonymous GET/rest/api/user/current PUT/rest/api/user/current GET/rest/api/user/memberof GET/rest/api/user GET/rest/api/user/list

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

curl

Node.js

Java

Python

PHP

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

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/user/anonymous' \
  --header 'Accept: application/json'

200Response

{
  "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

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/user/current' \
  --header 'Accept: application/json'

200Response

{
  "profilePicture": {
    "path": "http://www.example.com/path/to/image.png",
    "width": 16,
    "height": 16,
    "isDefault": true
  },
  "displayName": "Joe Smith",
  "type": "<string>"
}

PUT

Update details of the current user

Change the current user's details.

Validation Rules:

Full name cannot be blank, containing <> characters or be reserved by Confluence.
Email must be a valid email address.
Current password must be supplied for changing email address.

Example PUT request URI(s): http://example.com/confluence/rest/api/user/current

Request

Request bodyapplication/json

User details

fullName

string

email

string

currentPassword

string

Responses

Returned if the update was successful.

PUT/rest/api/user/current

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/confluence/rest/api/user/current' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "Some User",
  "email": "someuser@someemail.com",
  "currentPassword": "password"
}'

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

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/user/memberof' \
  --header 'Accept: application/json'

200Response

{
  "results": [
    {
      "profilePicture": {
        "path": "http://www.example.com/path/to/image.png",
        "width": 16,
        "height": 16,
        "isDefault": true
      },
      "displayName": "Joe Smith",
      "type": "<string>"
    }
  ],
  "totalCount": 2154,
  "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"
  }
}

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

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/user' \
  --header 'Accept: application/json'

200Response

{
  "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

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/user/list' \
  --header 'Accept: application/json'

200Response

{
  "results": [
    {
      "profilePicture": {
        "path": "http://www.example.com/path/to/image.png",
        "width": 16,
        "height": 16,
        "isDefault": true
      },
      "displayName": "Joe Smith",
      "type": "<string>"
    }
  ],
  "totalCount": 2154,
  "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"
  }
}