Profiles
Updated at January 7th, 2025
Profiles relate to system permissions and enabled activities assigned to a group of agents (managers).
When looking for a specific user, the USER ID is required.
The profile ID is required when selecting a specific profile (See Enum section).
GET: Get Managers by Profile ID
This API returns a list of all the agents that share the specified Profile Id.
GET/managers/profiles/{PROFILE_ID}
path Parameters
|
PROFILE_ID required
|
integer <int64>
Profile ID. This is a CIRRUS generated number |
Response Schema: application/json
| status | string
|
||||||||||||||
| description | string
|
||||||||||||||
| response_time | string
|
||||||||||||||
Array of objects or objects
|
|||||||||||||||
Array
One of
| |||||||||||||||
GET: Get Profiles
A profile is a set of permissions the agent has access to.
This API returns a list of all agents’ profile Ids and profile names.
API Returns
"Id" refers to the profile Id number
"Name" is the name of the profile
"UniqueName" is a secondary name (optional)
GET/managers/profiles
Response Schema: application/json
| status | string
|
||||||
| description | string
|
||||||
| response_time | string
|
||||||
Array of objects or objects
|
|||||||
Array
One of
| |||||||
DEL: Remove ALL Agent Profiles
This API removes all profiles from a specific agent/admin.
The agent Id is a required path parameter. You can obtain a list of agent Ids from the Get Manager API.
DELETE/managers/{MANAGER_ID}/profiles
path Parameters
|
MANAGER_ID required
|
integer <int64>
Manager Id is a Cirrus generated number for the agent Id. |
Response Schema: application/json
| status | string
|
| description | string
|
| response_time | string
|
| data | string |
POST: Add Profiles
This API Adds or changes the profiles of a specific agent/admin.
The Manager Id of the agent is required, as well as the specific profile Id or name.
To Add profiles, set the Query parameter to “add” and enter the profile’s name or Id. Separate multiple profiles with a comma.
To Change profiles (delete the current and add the new), set the Query parameter to “set” and enter the profile’s name or Id. Separate multiple profiles with a comma.
Note that only one query parameter should be used – not both.
API Sends URL + Manager’s Id q=[profile id]
POST/managers/{MANAGER_ID}/profiles
path Parameters
|
MANAGER_ID required
|
integer <int64>
Manager ID. This is a commbox generated number |
query Parameters
| add | Array of integers non-empty
|
| set | Array of integers non-empty |
Response Schema: application/json
| status | string
|
||||||
| description | string
|
||||||
| response_time | string
|
||||||
Array of objects or objects
|
|||||||
Array
One of
| |||||||
DEL: Delete Manager Profile
This API removes a specific profile from a specific agent/admin.
The agent Id and profile Id are required path parameters. You can obtain a list of agent Ids from the Get Manager API and a list of profiles from the Get Profile API.
DELETE/managers/{MANAGER_ID}/profiles/{PROFILE_ID}
path Parameters
|
MANAGER_ID required
|
integer <int64>
Manager ID. This is a Cirrus generated number |
|
PROFILE_ID required
|
integer <int64>
Profile ID. This is a Cirrus generated number |
Response Schema: application/json
| status | string
|
| description | string
|
| response_time | string
|
| data | string |
