POST

Change password

Change the password for the user identified by the username.

Validation rules :

  • The new password should not be null or blank.

Request

Path parameters

username

string

Required

Request bodyapplication/json

password

string

Responses

returns no content if the password is changed successfully

POST/rest/api/admin/user/{username}/password
1 2 3 4 5 6 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/admin/user/{username}/password' \ --header 'Content-Type: application/json' \ --data '{ "password": "password" }'
POST

Create user

One of the following options could be used:

  1. Create a user with a specified password. The userName, fullName, email and password needs to be specified.

  2. Create a user with an email notification to the user. The userName, fullName, email and notifyViaEmail (true) needs to be specified.

Requirements:

  • The userName should not be null or blank

  • The userName should not contain any of these characters \ , + < > ' "

  • The userName should not contain any whitespace characters

  • The userName should not be "anonymous"

  • The userName should not contain any upper case characters

  • The fullName should not be null or blank

  • The fullName should not contain any of these characters

  • The fullName should not be "anonymous"

  • The email should not be null or blank

  • The email should be a valid email address

  • If notifyViaEmail is false then the password should not be null or blank

  • If notifyViaEmail is true then the password should not be specified

Request

Request bodyapplication/json

Details of the user to be created

userName

string

fullName

string

email

string

password

string

notifyViaEmail

boolean

Responses

returns a response with generated UserKey for the created user.

application/json

UserKey
POST/rest/api/admin/user
1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/admin/user' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "userName": "user1", "fullName": "Some User", "email": "someuser@someemail.com", "password": "password", "notifyViaEmail": true }'
201Response
1 2 3 { "userKey": "4028d6768851c8900188556ba6000014" }
PUT

Update user

Updates the user identified by the username. The following fields can be updated: email, full name. "Requirements:

  • The fullName should not be blank
  • The fullName should not contain any forbidden characters (< or >)
  • The fullName should not be anonymous (in english or other system locale)
  • The email should not be blank
  • The email should be a valid email address

Request

Path parameters

username

string

Required

Request bodyapplication/json

Details of the user to be updated

fullName

string

email

string

currentPassword

string

Responses

Returned if the update was successful.

application/json

UserKey
PUT/rest/api/admin/user/{username}
1 2 3 4 5 6 7 8 9 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/admin/user/{username}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "fullName": "Some User", "email": "someuser@someemail.com", "currentPassword": "password" }'
204Response
1 2 3 { "userKey": "4028d6768851c8900188556ba6000014" }
DEL

Delete user

Deletes the given User identified by username. This action is processed asynchronously.

Request

Path parameters

username

string

Required

Responses

Produces a HTTP Accept 202 response from some other resource pointing to this class's LongTaskStatus resource.

application/json

LongTaskSubmission
DEL/rest/api/admin/user/{username}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/confluence/rest/api/admin/user/{username}' \ --header 'Accept: application/json'
202Response
1 2 3 4 5 6 7 8 9 { "id": "<string>", "links": { "result": "http://localhost:8080/confluence/rest/api/longtask/123/result", "status": "http://localhost:8080/confluence/rest/api/longtask/123/status" }, "resultPath": "result", "statusPath": "status" }
PUT

Disable user

Disables the given User identified by username. This method is idempotent i.e. if the user is already disabled then no action will be taken.

Request

Path parameters

username

string

Required

Responses

returns no content if the user is disabled

PUT/rest/api/admin/user/{username}/disable
1 2 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/admin/user/{username}/disable'
PUT

Enable user

Enables the given User identified by username. This method is idempotent i.e. if the user is already enabled then no action will be taken.

Request

Path parameters

username

string

Required

Responses

returns no content if the user is enabled

PUT/rest/api/admin/user/{username}/enable
1 2 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/admin/user/{username}/enable'

Rate this page: