Create and Search User Group

Creates a partner- or client-level user group, and searches user groups.

get
/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

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Default: 1

  • pageSizeinteger

    Default: 100

  • sortNamestring

    Default: id

  • isDescendingOrderboolean

00
post
/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

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

00
00