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

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Default: 1

  • pageSizeinteger

    Default: 100

  • sortNamestring

    Default: id

  • isDescendingOrderboolean

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

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

Request Body

application/json

  • uniqueIdstring

  • namestring

    User group name.

  • descriptionstring

    Short summary describing the user group.

  • createdTimestring

  • updatedTimestring

  • emailstring

    User group email address.

  • rolesarray

    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.

Loading Examples...

Responses

  • uniqueIdstring

  • namestring

    User group name.

  • descriptionstring

    Short summary describing the user group.

  • createdTimestring

  • updatedTimestring

  • emailstring

    User group email address.

  • rolesarray

    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.

Loading Examples...