Manage User for User Group

Adds, gets, and deletes users for a user group.

Gets users for a user group.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • userGroupIdstringrequired

    Unique Identifier (UUID) the user group

Query Parameters

  • pageNointeger

    Default: 1

  • pageSizeinteger

    Default: 100

  • sortNamestring

    Default: id

  • isDescendingOrderboolean

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

Adds users to an existing user group.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • userGroupIdstringrequired

    Unique Identifier (UUID) the user group

Request Body

application/json

  • idstring

    Provide user ID to add user into the group. To fetch the users within a tenant, use the Search Users API.

Loading Examples...

Responses

200OK

Deletes users from an existing user group.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • userGroupIdstringrequired

    Unique Identifier (UUID) the user group

Request Body

application/json

  • idstring

    Provide user ID to add user into the group. To fetch the users within a tenant, use the Search Users API

Loading Examples...

Responses

200OK