Create and Search User Group
Creates a partner- or client-level user group, and searches user groups.
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
- tenantId
Describes the clientId or mspId of the tenant
Query Parameters
- pageNo
Default: 1
- pageSize
Default: 100
- sortName
Default: id
- isDescendingOrder
Responses
- results
- totalResults
- orderBy
- pageNo
- pageSize
- totalPages
- nextPage
- previousPageNo
- descendingOrder
Response Samples
{
"results": [
{
"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567",
"name": "Lab Escalation Users",
"description": "Network Lab Escalation Users",
"createdTime": "2016-07-23T16:46:41+0000",
"updatedTime": "2017-10-06T06:40:51+0000",
"email": "joe@gmail.com"
},
{
"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff",
"name": "Linux Issues Support",
"description": "Linux Issues Support Group",
"createdTime": "2016-07-23T16:46:02+0000",
"updatedTime": "2017-06-06T10:59:17+0000"
}
],
"totalResults": 2,
"orderBy": "userGroup.id",
"pageNo": 1,
"pageSize": 100,
"totalPages": 1,
"nextPage": false,
"previousPageNo": 0,
"descendingOrder": true
}
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
- tenantId
Describes the clientId or mspId of the tenant
Request Body
application/json
- uniqueId
- name
User group name.
- description
Short summary describing the user group.
- createdTime
- updatedTime
- email
User group email address.
- roles
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.
Request Body Samples
{
"name": "Network Admins",
"description": "Level A Network Administrators",
"email": "network.admins@myorganization.com",
"roles": [
{
"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc"
}
]
}
Responses
- uniqueId
- name
User group name.
- description
Short summary describing the user group.
- createdTime
- updatedTime
- email
User group email address.
- roles
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.
Response Samples
{
"uniqueId": "USRGRP-9a68ce5d-c5cd-40a2-9fa6-e496dfe6e01b",
"name": "Network Admins",
"description": "Level A Network Administrators",
"createdTime": "2017-10-16T08:17:17+0000",
"updatedTime": "2017-10-16T08:26:29+0000",
"email": "network.admins@myorganization.com",
"roles": [
{
"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc",
"name": "Network Admin Role",
"description": "Level A network administrators to manage all network resources of site SJ",
"defaultRole": false
}
]
}