Searching for Roles via the Role Name

Description

You will have many roles created within WSO2 EMM. As the admin you will need to confirm if a given role exists in the EMM. In such situation you can search for the role by giving a character or a few characters of the role name. The search will give you a list of roles that have the name in the exact order of the characters you provided.

Resource Path /search

URL /mdm-admin/roles/search?filters={filters}

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/roles/search?filters={filters}

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 characters in the role name as the value for {filters}.

Example:

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/roles/search?filters=a

Sample output

> GET /mdm-admin/roles/search?filter=a HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer a99d5fff08eefff282b413d86cac7d00
> 
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Sun, 06 Mar 2016 12:18:08 GMT
< Content-Type: application/json
< Content-Length: 133
< Server: WSO2 Carbon Server
{"statusCode":200,"messageFromServer":"All matching user roles were successfully retrieved.","responseContent":["admin","marketing"]}

Sample JSON Output
Definition

[
  "admin",
  "marketing"
]

Property Description

roles

The user roles in WSO2 EMM are given as comma separated string values.

For example: Using the REST API command you filter the role names having the letter A. Therefore a list of roles having the letter A is given to you.