Manage User Groups
Updates, gets, and deletes user groups.
Gets the details of a user group.
Path Parameters
- tenantId
Describes the clientId or mspId of the tenant
- userGroupId
Unique Identifier (UUID) the user group
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.
Updates user group properties.
Path Parameters
- tenantId
Describes the clientId or mspId of the tenant
- userGroupId
Unique Identifier (UUID) the user group
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.
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.
Deletes a user group for a tenant.
Path Parameters
- tenantId
Describes the clientId or mspId of the tenant
- userGroupId
Unique Identifier (UUID) the user group