Manage User Groups

Updates, gets, and deletes user groups.

Gets the details of a user group.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • userGroupIdstringrequired

    Unique Identifier (UUID) the user group

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...

Updates user group properties.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • userGroupIdstringrequired

    Unique Identifier (UUID) the user group

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...

Deletes a user group for a tenant.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • userGroupIdstringrequired

    Unique Identifier (UUID) the user group

Responses

200OK