Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
Description

A user is able to change the password to secure their EMM profile via the REST API given below.

Resource Path/change-password
URL/mdm-admin/users/change-password
HTTP MethodPOST
Request/Response Formatapplication/json
cURL command
Code Block
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/change-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:

Code Block
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'user.json' -k -v https://localhost:9443/mdm-admin/users/change-password
 Sample output
Code Block
 > POST /mdm-admin/users/change-password HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 9ffd50a15654de12e677ebaac9767597
> Content-Length: 83
< HTTP/1.1 201 Created
< Date: Mon, 21 Mar 2016 12:22:20 GMT
< Content-Type: application/json
< Content-Length: 97
< Server: WSO2 Carbon Server
{"statusCode":201,"messageFromServer":"User password by username: kim was successfully changed."}
Anchor
sample
sample
Sample JSON Definition 
Code Block
{  
   "username":"kim",
   "oldPassword":"a2ltJDEyMzQ=",
   "newPassword":"a2ltJDEyYmFy"
}
PropertyDefinitionData
Type 
username

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

String
oldPassword

Provide the current password in the base64 encoded format.

Expand
titleClick here for more information on how to encode the password
  1. Access any base64 encoder. 
    For example: https://www.base64encode.org/
  2. Enter the current password.
    For example:
    kim$1234
  3. Click Encode to generate the encoded key.
    The following is an example of an encoded key:
    a2ltJDEyMzQ=
String
newPassword

Provide the new password in the base64 encoded format.

Expand
titleClick here for more information on how to encode the passwword
  1. Access any base64 encoder. 
    For example: https://www.base64encode.org/
  2. Enter the current password.
    For example:
    barKim$5467
  3. Click Encode to generate the encoded key.
    The following is an example of an encoded key:
    YmFyS2ltJDU0Njc=
String