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.

Response Samples

{
  "uniqueId": "USRGRP-9a68ce5d-c5cd-40a2-9fa6-e496dfe6e01b",
  "name": "Level A Administrators",
  "description": "IT Administration Managers in SJ Site",
  "createdTime": "2017-10-16T08:17:17+0000",
  "updatedTime": "2017-10-16T08:29:32+0000",
  "email": "levelA.admins@myorganization.com",
  "roles": [
    {
      "uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc",
      "name": "IT Admin Permissions",
      "description": "All Permissions of an IT Admin Manager",
      "defaultRole": false
    },
    {
      "uniqueId": "ROLE-836704cd-9faf-355e-6995-f124e1c5de48",
      "name": "Minimal Cloud Instance Permissions",
      "description": "AWS Cloud Instances Permissions",
      "defaultRole": false
    }
  ]
}

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.

Response Samples

{
  "uniqueId": "USRGRP-9a68ce5d-c5cd-40a2-9fa6-e496dfe6e01b",
  "name": "Windows Admin Group",
  "description": "Windows Admins in North-West location",
  "createdTime": "2017-10-16T08:17:17+0000",
  "updatedTime": "2017-10-16T08:29:32+0000",
  "email": "windows.admins@myorganization.com",
  "roles": [
    {
      "uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc",
      "name": "Admin Permissions",
      "description": "Permissions for Windows team",
      "defaultRole": false
    },
    {
      "uniqueId": "ROLE-836704cd-9faf-355e-6995-f124e1c5de48",
      "name": "Minimal Dev Permissions",
      "description": "Permissions on minimal Windows devices",
      "defaultRole": false
    }
  ]
}

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