Updating Details of a User

Description

There will be situations where you will want to update the user details. In such situation you can update the user details using the REST API given below.

URL /mdm-admin/users?username={username}

HTTP Method PUT

Request/Response Format application/json

cURL command

curl -X PUT -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?username={username}

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 updated user details as the <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.
Provide the name of the user you wish to update as the {username}.

Example:

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'user.json' -k -v https://localhost:9443/mdm-admin/users?username=kim

Sample output

> PUT /mdm-admin/users?username=kim HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a
> Content-Length: 125
< HTTP/1.1 201 Created
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Sat, 05 Mar 2016 09:17:09 GMT
< Content-Type: application/json
< Content-Length: 88
< Server: WSO2 Carbon Server
{"statusCode":201,"messageFromServer":"User by username: kim was successfully updated."}

Sample JSON Definition

{  
   "username":"kim",
   "firstname":"Kim",
   "lastname":"Foo",
   "emailAddress":"kim@gmail.com",
   "roles":[  
      "admin"
   ]
}

Property	Definition	Data Type
`username`	Provide a preferred username for the user. Please note that you should not update the username.	String
`firstname`	Provide the first name of the user.	String
`lastname`	Provide the last name of the user.	String
`emailAddress`	Provide the email address of the user. You need to ensure that you provide a valid email address as an email containing the URL to download the EMM mobile application will be sent to the user once the user is added successfully.	String
`roles`	Provide the user roles for the respective user. For more information on the roles you have created, see getting details of user roles. All roles starting with `Application/` are created for Service Providers (i.e., `Application/admin_emm` ). These roles only have permission to subscribe to the respective Service-provider application. Therefore make sure not to assign users to the roles starting with `Application/`.	String