Groups

These API’s are for creating, accessing, and maintaining security groups inside of CM Box.

GET /api/security/groups

Retrieves a list of groups

Params

none

Response

name - Name of the group

id - id of the group

searchId - id used is searches

roles - array list of roles assigned to this group

users - array list of users assigned to this group

type - the data type - "group"

Example Response

{
    "name": "Example Group",
    "id": "Example Group",
    "searchId": "Example Group",
    "roles": [
        "admin"
    ],
    "users": [
        "user1@fishbowlsolutions.com",
        "user2@fishbowlsolutions.com"
    ],
    "type": "group",
    "description": "",
},
{
    "name": "Example Group2",
    "id": "Example Group2",
    "searchId": "Example Grou2",
    "roles": [
        "admin"
    ],
    "users": [],
    "type": "group",
    "description": "",
}

GET /api/security/groups/:id

Retrieves the group based on the specified group id.

Params

:id - ID of the security group

Response

name - Name of the group

id - id of the group

searchId - id used is searches

roles - array list of roles assigned to this group

users - array list of users assigned to this group

type - the data type - "group"

Example Response

{
    "name": "Example Group",
    "id": "Example Group",
    "searchId": "Example Group",
    "roles": [
        "admin"
    ],
    "users": [
        "user1@fishbowlsolutions.com",
        "user2@fishbowlsolutions.com"
    ],
    "type": "group",
    "description": "",
}

POST /api/security/groups/:group_id

Create a new security group.

Params

group_id - ID of the new group

Request

Content-Type: application/json

{
  "id": "exampleGroup",
  "name": "Example Group",
  "roles": [],
  "users": [],
  "type": "group",
  "description": ""
}

Response

200 - OK on success

PUT /api/security/groups/:group_id

Used to add a group(s) based on the group id

Params

group_id: ID of the group you wish to update

Request

groups: Array of user groups to replace the groups for the desired user.

roles: Array of user roles to replace the roles for the desired user

Response

200 - OK on success

DELETE /api/security/roles/:group_id

Used to delete a group based on the group id

Params

group_id: ID of the group you wish to delete

Response

200 - OK on success