| Description | Retrieve the details of a selected policy in WSO2 EMM. |
|---|
| Resource Path | /{id} |
|---|
| URL | /mdm-admin/policies/{id} |
|---|
| 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/policies/{id} |
- 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 the policy ID as the value for
{id}. If you are unsure of the policy IDs run the REST API command to retrieve all the policy details.
Example: Retrieve the policy details of the policy having the ID 1. | Code Block |
|---|
curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/policies/1 |
|
|---|
| Sample output | | Code Block |
|---|
> GET /mdm-admin/policies/1 HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Thu, 25 Feb 2016 09:53:45 GMT
< Content-Type: application/json
< Content-Length: 652
< Server: WSO2 Carbon Server
{"id":1,"priorityId":1,"profile":{"profileId":1,"profileName":"Camera","tenantId":-1234,"deviceType":{"id":1,"name":"android"},"createdDate":"Feb 25, 2016 12:00:18 PM","updatedDate":"Feb 25, 2016 12:00:18 PM","profileFeaturesList":[{"id":1,"featureCode":"CAMERA","profileId":1,"deviceTypeId":1,"content":"{\"enabled\":true}"}]},"policyName":"Camera","generic":false,"roles":[],"ownershipType":"ANY","devices":[],"users":[],"active":false,"updated":false,"description":"Optional","compliance":"enforce","policyCriterias":[],"tenantId":-1234,"profileId":1} |
|
|---|
| Sample JSON Definition | | Code Block |
|---|
{
"id":1,
"priorityId":1,
"profile":{
"profileId":1,
"profileName":"Camera",
"tenantId":-1234,
"deviceType":{
"id":1,
"name":"android"
},
"createdDate":"Feb 25, 2016 12:00:18 PM",
"updatedDate":"Feb 25, 2016 12:00:18 PM",
"profileFeaturesList":[
{
"id":1,
"featureCode":"CAMERA",
"profileId":1,
"deviceTypeId":1,
"content":"{\"enabled\":true}"
}
]
},
"policyName":"Camera",
"generic":false,
"roles":[
],
"ownershipType":"ANY",
"devices":[],
"users":[],
"active":false,
"updated":false,
"description":"Optional",
"compliance":"enforce",
"policyCriterias":[],
"tenantId":-1234,
"profileId":1
} |
| Property value | Description |
|---|
id | The policy ID. | priorityId | The priority order of the policy. 1 indicates the highest priority | profile | Contains the details of the profile that is included in the policy. Example: The policy will contain a profile of disabling a camera on a device and encrypting the storage. | profileId | The ID of each profile that is in the selected policy. | profileName | The name of the profile. | tenantId | The ID of the tenant that added the policy. | deviceType | Contains the device type details the policy was created for. | id | The ID of the device type. | name | The device platform type. | createdDate
| The date the policy was created. | updatedDate
| The date the changes made to the policy was published to the devices registered with the EMM. | profileFeaturesList | Contains the features specific to each profile in the policy. | id | The ID of the feature list. | featurecode | The code specific for the feature of the profile. The code that defines the profile. Example for feature codes: PASSCODE_POLICY, CAMERA and ENCRYPT_STORAGE. | profileId | The ID of the profile the features belong to. | deviceTypeId | The Id of the device type. | content | Contains the details of the features and the values assigned when adding the policy. | policyName | The name of the policy. | generic | | roles | The roles to whom the policy is applied on. | ownershipType | The policy ownership type. It can be any of the following values: ANY - The policy will be applied on the BYOD and COPE device types.BYOD (Bring Your Own Device) - The policy will only be applied on the BYOD device type.COPE (Corporate-Owned, Personally-Enabled) - The policy will only be applied on the COPE device type.
| devices | Lists out the devices the policy is enforced on. This field will be empty if you have not defined to what devices the policy needs to be applied on. If a policy is enforced on a device when the device registers with EMM, those device details will not be shown here. | users | Lists out the users on whose devices the policy is enforced. | activate | If the value is true it indicates that the policy is active. If the value is false it indicates that the policy is inactive. | updated | If you have made changes to the policy but have not applied these changes to the devices that are registered with EMM, then the value is defined as true. But if you have already applied any changes made to the policy then the value is defined as false. | description | Gives a description on the policy. | compliance | Provides the non-compliance rules. WSO2 EMM provides the following non-compliance rules: - Enforce - Forcefully enforce the policies on the devices.
- Warning - If the device does not adhere to the given policies a warning message will be sent.
- Monitor - If the device does not adhere to the given policies the server is notified of the violation unknown to the user and the administrator can take the necessary actions with regard to the reported.
| policyCriteria
| If you added a policy criteria other than the ones given via WSO2 EMM when adding a policy, those additional details will be given here. | tenantId | The ID of the tenant that created the policy. | profileId | The ID of the profile. |
|
|---|
|