Page Comparison

Excerpt

Description

You will have 100+ users registered with WSO2 EMM. If you want wish to retrieve the user details of a specific user, and you only remember the users email addresspart of the user's username, you are able to retrieve the user details using the REST API given below.by giving a character or a few characters in the username.

Resource Path /view-users-by-username

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

HTTP Method GET

Request/Response Format application/json

cURL command

Code Block
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/view-users-by-username?username={username}

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.
Provide any user detail of the user as the value for {username} to retrieve the user details, such as email address, first name or last name.

Example:

Code Block
curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/users/view-users-by-username?username=kim@gmail.comi

Sample output

Code Block

> GET /mdm-admin/users/view-users?username=kim@gmail.com HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 465488cd92c200d3203d138438e9f24d
> 
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Sat, 05 Mar 2016 08:28:07 GMT
< Content-Type: application/json
< Content-Length: 135
< Server: WSO2 Carbon Server
< 
* Connection #0 to host localhost left intact
{"statusCode":200,"messageFromServer":"All users by username were successfully retrieved. Obtained user count: 03","responseContent":[{"username":"admin"},{"username":"jim","firstname":"Jim","lastname":"Bar","emailAddress":"jim@gmail.com"},{"username":"kim","firstname":"Kim","lastname":"Bar","emailAddress":"kim@gmail.com"}]}

Sample JSON Output
Definition

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

The user details of the users having the letter I in their user names is given as the output:

Property	Definition
`username`	The name of the user. In this sample all the users having the letter I in their user name are given.
`firstname`	The first name of the user.
`lastname`	The last name of the user.
`emailaddress`	The email address of the user.

Versions Compared

Old Version 2

New Version Current

Key