Groups Resource

Provides access and management of groups.

GET /{tenantGuid}/api/v1/groups

Available Since:
12.6.0

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

Sample request

 GET /SRP00000/api/v1/groups?query=profileGuid=3d55abd2-c00e-4f5f-abcf-01c92ac777b1,userGuid=6dd3a8e2-3f24-48c6-961a-949794f4b554

Sample response body

 
 {
  "groups" : [ {
    "guid" : "6d0c4ddb-10ae-471d-948d-df27868dcf8a",
    "name" : "Test group name",
    "description" : "Test group description",
    "directoryLinked" : false
   } ]
 }

Request Parameters
Name Location Description
query query (Optional) A query for filtering the group results. The name field cannot be used with other fields. The profileGuid and userGuid 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 group. Case insensitive exact match.
profileGuid string Specify this to get groups that have this profile assigned to them.
userGuid string Specify this to get groups that have this user assigned to them.
Response Codes
Code Condition Data type
200 OK (even if no groups are found).
400 Invalid search query.
Response Body
Media type Data type
application/vnd.blackberry.groups-v1+json Groups (JSON)

POST /{tenantGuid}/api/v1/groups

Available Since:
12.7.0

Create a user group. Only the name field of the group is required. The description field is optional.

Samples

Sample request body

 
 {
  "name":"Test group name",
  "description":"Test group description"
 }

Sample response body

 
 {
  "guid":"6d0c4ddb-10ae-471d-948d-df27868dcf8a",
  "name":"Test group name",
  "description":"Test group description",
  "directoryLinked":false
 }

Request Body
Media type Data type
application/vnd.blackberry.group-v1+json Group (JSON)
Response Codes
Code Condition Data type
201 Group created.
400 Invalid request. For example, invalid field semantics or missing required field.
409 Group already exists.
Response Body
Media type Data type
application/vnd.blackberry.group-v1+json Group (JSON)
Response Headers
Name Description
Location Location of the created group. Can be used to perform a GET request to retrieve the group. Only present when status is 201.

DELETE /{tenantGuid}/api/v1/groups/{groupGuid}

Available Since:
12.7.0

Delete a user group.

Request Parameters
Name Location Description
groupGuid path GUID of the user group to delete.
Response Codes
Code Condition Data type
204 Group deleted.
    400 Invalid request. For example, invalid field semantics or missing required field.
    404 Group not found.

    GET /{tenantGuid}/api/v1/groups/{groupGuid}

    Available Since:
    12.6.0

    Get user group by a specific GUID.

    Sample response body

     
 {
  "guid":"6d0c4ddb-10ae-471d-948d-df27868dcf8a",
  "name":"Test group name",
  "description":"Test group description",
  "directoryLinked":false
 }

    Request Parameters
    Name Location Description
    groupGuid path GUID of the group to get
    Response Codes
    Code Condition Data type
    200 OK.
    404 Group not found.
    Response Body
    Media type Data type
    application/vnd.blackberry.group-v1+json Group (JSON)

    POST /{tenantGuid}/api/v1/groups/{groupGuid}/applications

    Available Since:
    12.7.0

    Assign one or more applications, by GUID, to a user group. If the application is already assigned the disposition will be updated. Only the GUID field of each application is required.

    Sample request body

      
  {
    "applicationAssignments" : [ {
      "application" : {
        "guid" : "aa291d31-3b51-4424-a09c-7b127ee398a8"
      },
      "disposition" : "OPTIONAL"
    }, {
      "application" : {
        "guid" : "841e0146-07d5-4963-947c-dcabe7293806"
      },
      "disposition" : "REQUIRED"
    } ]
   }

    Request Parameters
    Name Location Description
    groupGuid path GUID of the group to assign applications to.
    Request Body
    Media type Data type
    application/vnd.blackberry.applicationassignments-v1+json Application assignments (JSON)
    Response Codes
    Code Condition Data type
    204 Applications(s) assigned.
      400 Invalid request. For example, invalid field semantics or missing required field.
      404 Application not found.

      Group not found.

      DELETE /{tenantGuid}/api/v1/groups/{groupGuid}/applications/{appGuid}

      Available Since:
      12.7.0

      Unassign an application, by GUID, from a user group.

      Request Parameters
      Name Location Description
      appGuid path GUID of the application to unassign.
      groupGuid path GUID of the group to unassign the application from.
      Response Codes
      Code Condition Data type
      204 Application unassigned.
        400 Invalid request. For example, invalid field semantics or missing required field.
        404 Application not found.

        Group not found.

        GET /{tenantGuid}/api/v1/groups/{groupGuid}/profiles

        Available Since:
        12.6.0

        Get all profiles directly assigned to a user group.

        Sample response body

         
  {
    "profiles" : [ {
    "guid" : "3d55abd2-c00e-4f5f-abcf-01c92ac777b1",
    "name" : "Sample Policy",
    "categoryName" : "IT_CONFIG",
    "default" : false
    }, {
    "guid" : "6106fce8-83f5-44b3-8288-e8e4e0966561",
    "name" : "Default Email Profile",
    "categoryName" : "EMAIL",
    "default" : false
    } ]
  }

        Request Parameters
        Name Location Description
        groupGuid path GUID of the group to get assigned profiles for
        Response Codes
        Code Condition Data type
        200 OK.
        404 Group not found.
        Response Body
        Media type Data type
        application/vnd.blackberry.profiles-v1+json Profiles (JSON)

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

        Available Since:
        12.6.0

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

        Sample request body

         
  {
    "profiles" : [ {
    "guid" : "3d55abd2-c00e-4f5f-abcf-01c92ac777b1"
    }, {
    "guid" : "6106fce8-83f5-44b3-8288-e8e4e0966561"
    } ]
  }

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

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

          Available Since:
          12.6.0

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

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

            DELETE /{tenantGuid}/api/v1/groups/{groupGuid}/users

            Available Since:
            12.7.0

            Remove one or more users, by GUID, from a user group. Only the GUID field of each user is required. Removing users from a directory linked group is not supported.

            Sample request body

             
  {
    "users" : [ {
    "guid" : "6dd3a8e2-3f24-48c6-961a-949794f4b554"
    }, {
    "guid" : "f712cbb0-a36e-4f22-8a1a-f1c0fae6db97"
    } ]
  }

            Request Parameters
            Name Location Description
            groupGuid path GUID of the group to remove users from.
            Request Body
            Media type Data type
            application/vnd.blackberry.users-v1+json Users (JSON)
            Response Codes
            Code Condition Data type
            204 User(s) removed.
              400 Invalid request. For example, invalid field semantics or missing required field.
              404 Group not found.

              User not found.

              POST /{tenantGuid}/api/v1/groups/{groupGuid}/users

              Available Since:
              12.7.0

              Add one or more users, by GUID, to a user group. Only the GUID field of each user is required. Adding users to a directory linked group is not supported.

              Sample request body

               
  {
    "users" : [ {
    "guid" : "6dd3a8e2-3f24-48c6-961a-949794f4b554"
    }, {
    "guid" : "f712cbb0-a36e-4f22-8a1a-f1c0fae6db97"
    } ]
  }

              Request Parameters
              Name Location Description
              groupGuid path GUID of the group to add users to.
              Request Body
              Media type Data type
              application/vnd.blackberry.users-v1+json Users (JSON)
              Response Codes
              Code Condition Data type
              204 User(s) added.
                400 Invalid request. For example, invalid field semantics or missing required field.
                404 Group not found.

                User not found.