Resetting the User Password

Description

In a situation where you need to block a user from accessing their EMM profile, the EMM administrator is able to reset the password. This will change the user's password and the user will not be able to able to login to the account as he/she is not aware of the new password.

Resource Path /reset-password

URL /mdm-admin/users/reset-password

HTTP Method POST

Request/Response Format application/json

cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/users/reset-password

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
Define the path to the JSON file, which includes the required properties to change a user password as <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'user.json' -k -v https://localhost:9443/mdm-admin/users/reset-password

Sample output

> POST /mdm-admin/users/reset-password HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 0fd1000b683015149711949919c2ce24
> Content-Length: 65
< HTTP/1.1 201 Created
< Date: Tue, 08 Mar 2016 06:43:54 GMT
< Content-Type: application/json
< Content-Length: 99
< Server: WSO2 Carbon Server
{"statusCode":201,"messageFromServer":"User password by username: admin was successfully changed."}

Sample JSON Definition

{
  username: "kim",
  oldPassword: "",
  newPassword: "aGVsbG8="
}

Property Definition Data
Type

username

Provide the name of the user you wish to change the password.

String

oldPassword You are not required to provide the old password. String

newPassword

Provide the new password in the base64 encoded format.

Click here for more information on how to encode the passwword

Access any base64 encoder.
For example: https://www.base64encode.org/
Enter the current password.
For example:
barKim$5467
Click Encode to generate the encoded key.
The following is an example of an encoded key:
YmFyS2ltJDU0Njc=

String