Change the password for the user identified by the username.
Validation rules :
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
returns no content if the password is changed successfully
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"
}'One of the following options could be used:
Create a user with a specified password. The userName, fullName, email and password needs to be specified.
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
Forge and OAuth2 apps cannot access this REST resource.
Details of the user to be created
string
string
string
string
boolean
returns a response with generated UserKey for the created 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
}'1
2
3
{
"userKey": "4028d6768851c8900188556ba6000014"
}Updates the user identified by the username. The following fields can be updated: email, full name. "Requirements:
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredDetails of the user to be updated
string
string
string
Returned if the update was successful.
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"
}'1
2
3
{
"userKey": "4028d6768851c8900188556ba6000014"
}Deletes the given User identified by username. This action is processed asynchronously.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredProduces a HTTP Accept 202 response from some other resource pointing to this class's LongTaskStatus resource.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/confluence/rest/api/admin/user/{username}' \
--header 'Accept: application/json'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"
}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.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredreturns no content if the user is disabled
1
2
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/admin/user/{username}/disable'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.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredreturns no content if the user is enabled
1
2
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/admin/user/{username}/enable'Rate this page: