Endpoint
/api/v2/tenants/{tenantId}/userGroups
Gets the list of tenant user groups.
Notes
- This API provides a paginated list with minimal details of user groups.
- Use Get User Group API to get the assigned roles to a user group.
- Use Get Users or a User Group API to get the ausers that are part of a user group.
Path Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
sortNamestring
isDescendingOrderboolean
Responses
OK
descendingOrderboolean
nextPageboolean
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
resultsarray
Child Parameters
- results.createdTime
- results.description
- (Optional) Short summary describing the user group.
- results.email
- (Optional) User group email address.
- results.name
- User group name.
- results.roles
- (Optional) Assign roles to user group. Users part of a group automatically inherit the permissions associated with that group. To get roles within a tenant, use Search Roles API.
- results.uniqueId
- results.updatedTime
totalPagesinteger
totalResultsinteger
{
"descendingOrder": true,
"nextPage": false,
"orderBy": "userGroup.id",
"pageNo": 1,
"pageSize": 100,
"previousPageNo": 0,
"results": [
{
"createdTime": "2016-07-23T16:46:41+0000",
"description": "Network Lab Escalation Users",
"email": "joe@gmail.com",
"name": "Lab Escalation Users",
"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567",
"updatedTime": "2017-10-06T06:40:51+0000"
},
{
"createdTime": "2016-07-23T16:46:02+0000",
"description": "Linux Issues Support Group",
"name": "Linux Issues Support",
"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff",
"updatedTime": "2017-06-06T10:59:17+0000"
}
],
"totalPages": 1,
"totalResults": 2
}
Endpoint
/api/v2/tenants/{tenantId}/userGroups
Creates a partner- or client-level user group.
Notes
- This API allows a user group to be created with minimal details like: user group name and roles.
- To add users to a user group, use the Add Users to User Group API.
Path Parameters
tenantIdstring
createdTimestring
descriptionstring
(Optional) Short summary describing the user group.
emailstring
(Optional) User group email address.
namestring
User group name.
rolesarray
(Optional) Assign roles to user group. Users part of a group automatically inherit the permissions associated with that group. To get roles within a tenant, use Search Roles API.
Child Parameters
- roles.allCredentials
- (Optional) - For partner specific role: To allow users in a role to view all credentials sets of all clients for a partner, provide allCredentials: true. - For client specific role: To allow users in a role to view all credential sets of all clients, provide allCredentials: true. Credential sets are client-specific. To allow users in a role to view only specific credential sets, provide only the credential set IDs of the client provided in clients.
- roles.allDevices
- (Optional) - For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. - For client specific role: To allow users to view all client devices, provide allDevices: true.
- roles.clients
- (Optional) Configure the visibility of clients for users in a role: - For partner-level users: To allow users of a role to view specific clients, provide the respective client IDs. Note: You can also create a role without visibility of any clients. - For client-level users: To assign a role to specific clients, provide the respective client IDs.
- roles.credentialSets
- (Optional) Configure visibility of credentials sets for users in a role: A partner or client specific role can be created to allow users in a role to view all credentials, specific credentials, or no credentials.
- roles.defaultRole
- roles.description
- (Optional) Short summary describing a role.
- roles.deviceGroups
- (Optional) For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. For client specific role: To allow users to view all client devices, provide allDevices: true.
- roles.devices
- (Optional) Configure the visibility of devices for users in a role: A partner and client specific roles can be created with visibility to all devices, specific devices and without any devices.
- roles.id
- roles.name
- Role name.
- roles.permissions
- (Optional) Assign permission sets to a role. All users in a role would be assigned these permissions. Search Permissions Sets API is used to get the list of permissions for a partner or client.
- roles.scope
- (Optional) Define the applicability of a role. - Provide scope: MSP to create a partner-level role. Note: MSP indicates a Partner. - Provide scope: CLIENT to create a client-level role.
- roles.userGroups
- (Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
- roles.users
- (Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
uniqueIdstring
updatedTimestring
{
"description": "Level A Network Administrators",
"email": "network.admins@myorganization.com",
"name": "Network Admins",
"roles": [
{
"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc"
}
]
}
Responses
OK
createdTimestring
descriptionstring
(Optional) Short summary describing the user group.
emailstring
(Optional) User group email address.
namestring
User group name.
rolesarray
(Optional) Assign roles to user group. Users part of a group automatically inherit the permissions associated with that group. To get roles within a tenant, use Search Roles API.
Child Parameters
- roles.allCredentials
- (Optional) - For partner specific role: To allow users in a role to view all credentials sets of all clients for a partner, provide allCredentials: true. - For client specific role: To allow users in a role to view all credential sets of all clients, provide allCredentials: true. Credential sets are client-specific. To allow users in a role to view only specific credential sets, provide only the credential set IDs of the client provided in clients.
- roles.allDevices
- (Optional) - For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. - For client specific role: To allow users to view all client devices, provide allDevices: true.
- roles.clients
- (Optional) Configure the visibility of clients for users in a role: - For partner-level users: To allow users of a role to view specific clients, provide the respective client IDs. Note: You can also create a role without visibility of any clients. - For client-level users: To assign a role to specific clients, provide the respective client IDs.
- roles.credentialSets
- (Optional) Configure visibility of credentials sets for users in a role: A partner or client specific role can be created to allow users in a role to view all credentials, specific credentials, or no credentials.
- roles.defaultRole
- roles.description
- (Optional) Short summary describing a role.
- roles.deviceGroups
- (Optional) For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. For client specific role: To allow users to view all client devices, provide allDevices: true.
- roles.devices
- (Optional) Configure the visibility of devices for users in a role: A partner and client specific roles can be created with visibility to all devices, specific devices and without any devices.
- roles.id
- roles.name
- Role name.
- roles.permissions
- (Optional) Assign permission sets to a role. All users in a role would be assigned these permissions. Search Permissions Sets API is used to get the list of permissions for a partner or client.
- roles.scope
- (Optional) Define the applicability of a role. - Provide scope: MSP to create a partner-level role. Note: MSP indicates a Partner. - Provide scope: CLIENT to create a client-level role.
- roles.userGroups
- (Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
- roles.users
- (Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
uniqueIdstring
updatedTimestring
{
"createdTime": "2017-10-16T08:17:17+0000",
"description": "Level A Network Administrators",
"email": "network.admins@myorganization.com",
"name": "Network Admins",
"roles": [
{
"defaultRole": false,
"description": "Level A network administrators to manage all network resources of site SJ",
"name": "Network Admin Role",
"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc"
}
],
"uniqueId": "USRGRP-9a68ce5d-c5cd-40a2-9fa6-e496dfe6e01b",
"updatedTime": "2017-10-16T08:26:29+0000"
}