Profiles Resource

Profiles provide the ability to assign functionality to a user or group.

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
    } ]
 }

Request Parameters
Name Location Description
query query (Optional) A query for filtering the profile results. The name field and categoryName field can be combined separated by a comma to narrow the results. Commas or backslashes in query values must be escaped with a backslash.
Field Type Description
name string Name of the profile. Case insensitive exact match.
categoryName string Name of the category type to get profiles for. See Profile categories for a list of supported values.
Response Codes
Code Condition Data type
200 OK (even if no profiles are found).
400 Invalid search query.
Response Body
Media type Data type Description
application/vnd.blackberry.profiles-v1+json Profiles (JSON)

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

Available Since:
12.10.0

Delete profile.

Request Parameters
Name Location Description
profileGuid path GUID of the profile to delete.
Response Codes
Code Condition Data type
204 Profile deleted.
    404 Profile not found.
    400 When attempting to delete a default 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
         }
     }
 }

    Request Parameters
    Name Location Description
    profileGuid path
    Response Codes
    Code Condition Data type
    200 OK.
    404 Profile not found.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.profile-v1+json Profile (JSON)

    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"
   } ]
 }

    Request Parameters
    Name Location Description
    profileGuid path GUID of the profile to assign to the provided groups.
    Request Body
    Media type Data type
    application/vnd.blackberry.groups-v1+json Groups (JSON)
    Response Codes
    Code Condition Data type
    204 Profile assigned.
      400 Invalid request. For example, invalid field semantics or missing required field.
      404 Profile not found.

      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.

      Request Parameters
      Name Location Description
      profileGuid path GUID of the profile to replace for all groups provided.
      Request Body
      Media type Data type
      application/vnd.blackberry.groups-v1+json Groups (JSON)
      Response Codes
      Code Condition Data type
      204 Profile assigned.
        400 Invalid request. For example, invalid field semantics or missing required field.
        404 Profile not found.

        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"
   } ]
 }

        Request Parameters
        Name Location Description
        profileGuid path GUID of the profile to assign to the provided uses.
        Request Body
        Media type Data type
        application/vnd.blackberry.users-v1+json Users (JSON)
        Response Codes
        Code Condition Data type
        204 Profile assigned.
          400 Invalid request. For example, invalid field semantics or missing required field.
          404 Profile not found.

          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.

          Request Parameters
          Name Location Description
          profileGuid path GUID of the profile to replace for all users provided.
          Request Body
          Media type Data type
          application/vnd.blackberry.users-v1+json Users (JSON)
          Response Codes
          Code Condition Data type
          204 Profile assigned.
            400 Invalid request. For example, invalid field semantics or missing required field.
            404 Profile not found.