Profiles Resource

GET /{tenantGuid}/api/v1/profiles

Available Since:

12.6.0

Get profiles with a specific query or all profiles. If no profiles are found, an empty profiles list is included in the response body.

Sample request

 GET /SRP00000/api/v1/profiles?query=name=Sample%20Policy,categoryName=IT_CONFIG
 

Sample response body

 {
  "profiles" : [ {
    "links": [
        {
            "rel": "entityDetails",
            "href": "https://server01:18084/SRP00000/api/v1/entities/com.blackberry.mdm.common.entity.profile.GoodSecurityProfile/a0da818a-afe1-4163-a1a7-80e17c37ea12"
         }
    ],
    "guid" : "3d55abd2-c00e-4f5f-abcf-01c92ac777b1",
    "name" : "Sample Policy",
    "description" : "Corporate profile.",
    "categoryName" : "IT_CONFIG",
    "default" : false
    } ]
 }
 

DELETE /{tenantGuid}/api/v1/profiles/{profileGuid}

Available Since:

12.10.0

Delete profile.

GET /{tenantGuid}/api/v1/profiles/{profileGuid}

Available Since:

12.11.0

Get details of a profile by GUID.

Only the following profile categories are supported: EMAIL (email profiles), IT_CONFIG (IT policies), or WIFI (Wi-Fi profiles).

Sample response body

 {
     "guid": "d23b733e-b22a-408b-bac8-1d53fa7fd281",
     "name": "Default",
     "description": "Default email profile",
     "categoryName": "EMAIL",
     "settings": {
         "all": {
             "domain": "example.com",
             "email.address": "pmorley@example.com",
             "server": "mail.example.com",
             "username": "pmorley"
         },
         "BB": {
             "accountName": "Work",
             "push.enabled": true,
             "ssl.enabled": true,
             "sync.calendar": true,
             "sync.contact": true
         },
         "android": {
             "ssl.enabled": true,
             "ssl.enabled.accept.all.certificates": false,
             "sync.period": 5,
             "usesmime": false
         },
        "ios": {
             "allow.move": false,
             "ssl.enabled": true,
             "ssl.enabled.accept.all.certificates": false,
             "sync.period": 7,
             "usesmime": false
         }
     }
 }
 

DELETE /{tenantGuid}/api/v1/profiles/{profileGuid}/depDevices

Available Since:

12.13.1

Unassign activation profile from one or more DEP devices by GUID. Only the GUID field of each DEP device is required. If a device listed in the request body doesn't have activation profile assigned or has assigned another profile, it will be ignored. If activation profile cannot be unassigned from one of the devices listed in the request, the entire batch is not unassigned, and an error message is returned.

Sample request body

 
 {
   "depDevices": [{
           "guid": "ef0e134a-093e-483c-886e-7ece1c3e39ca"
       },
       {
           "guid": "25a5cfc0-c6f3-4017-aa60-07c1e361f7da"
       }
   ]
 }
 

POST /{tenantGuid}/api/v1/profiles/{profileGuid}/depDevices

Available Since:

12.13.1

Assign activation profile to one or more DEP devices by GUID. Only the GUID field of each DEP device is required. If a device listed in the request body already has activation profile assigned, it will be overwritten. If activation profile cannot be assigned to one of the devices listed in the request, the entire batch is not assigned, and an error message is returned.

 
 {
   "depDevices": [{
           "guid": "ef0e134a-093e-483c-886e-7ece1c3e39ca"
       },
       {
           "guid": "25a5cfc0-c6f3-4017-aa60-07c1e361f7da"
       }
   ]
 }
 

POST /{tenantGuid}/api/v1/profiles/{profileGuid}/groups

Available Since:

12.7.0

Assign a profile to one or more user groups by GUID. Only the GUID field of each group is required.

Sample request body

 {
  "groups" : [ {
    "guid" : "6d0c4ddb-10ae-471d-948d-df27868dcf8a"
   } ]
 }
 

PUT /{tenantGuid}/api/v1/profiles/{profileGuid}/groups

Available Since:

12.6.0

Replace all profiles assigned to each user group by GUID. All existing profiles are removed and replaced by the profile provided. Only the GUID field of each group is required.

POST /{tenantGuid}/api/v1/profiles/{profileGuid}/users

Available Since:

12.7.0

Assign a profile to one or more users by GUID. Only the GUID field of each user is required.

Sample request body

 {
   "users" : [ {
     "guid" : "6dd3a8e2-3f24-48c6-961a-949794f4b554"
   }, {
     "guid" : "2d2d3a7f-076d-46f9-8c25-56cb8eba2800"
   } ]
 }
 

PUT /{tenantGuid}/api/v1/profiles/{profileGuid}/users

Available Since:

12.6.0

Replace all profiles assigned to each user by GUID. All existing profiles are removed and replaced by the profile provided. Only the GUID field of each user is required.