Getting Details of Users

Description

If you wish to get the details of all the user registered with WSO2 EMM, you can do so using the REST API.

Resource Path /

URL /mdm-admin/users/

HTTP Method GET

Request/Response Format application/json

cURL command

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/users/

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
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 GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/users/

Sample output

> GET /mdm-admin/users/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 9bc712cabb95bb1c7455274198e005b3
> 
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Fri, 04 Mar 2016 09:39:06 GMT
< Content-Type: application/json
< Content-Length: 313
< Server: WSO2 Carbon Server
< 
* Connection #0 to host localhost left intact
{"statusCode":200,"messageFromServer":"All users were successfully retrieved. Obtained user count: 3","responseContent":[{"username":"admin"},{"username":"foo","firstname":"foo","lastname":"bar","emailAddress":"foo@gmail.com"},{"username":"kim","firstname":"Kim","lastname":"Bar","emailAddress":"kim@gmail.com"}]}

Sample JSON Output Definition

{  
   "username":"kim",
   "firstname":"Kim",
   "lastname":"Bar",
   "emailAddress":"kim@gmail.com"
}

Property	Definition
`username`	Defines the username for the user.
`firstname`	Defines the first name of the user.
`lastname`	Defines the last name of the user.
`emailAddress`	Defines the email address of the user.