Searching for a User Name

Description

You will have 100+ users registered with WSO2 EMM. Therefore if you are unsure of the user name of a user and need to retrieve the details of a specific user, you can search for that user by giving a character or a few characters in the username. You will be given a list of users having the user name with the exact order of the characters you provided.

Resource Path /users-by-username

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

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/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 a character or a few character in the user name as the value for {username}

Example:

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/users/users-by-username?username=k

Sample output

> GET /mdm-admin/users/userS-by-username?username=k 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:17:06 GMT
< Content-Type: application/json
< Content-Length: 123
< Server: WSO2 Carbon Server
{"statusCode":200,"messageFromServer":"All users by username were successfully retrieved. Obtained user count: 3","responseContent":["admin","jim","kim"]}

Sample JSON Output
Definition

[
  "admin",
  "jim",
  "kim"
]

Property Description

usersname

The user names in WSO2 EMM that match the search are given as comma separated string values.

For example: Using the REST API command you filter the user names having the letter I. Therefore a list of users having the letter I is given to you.