Endpoint
/api/v2/tenants/{tenantId}/userGroups/{userGroupId}/users

Deletes users from an existing user group.

Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

userGroupId
string

Unique Identifier (UUID) the user group

id
string

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

[
  {
    "id": "USR0000000029"
  },
  {
    "id": "USR0000000030"
  }
]

Responses

OK

Endpoint
/api/v2/tenants/{tenantId}/userGroups/{userGroupId}/users

Gets users for a user group.

Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

userGroupId
string

Unique Identifier (UUID) the user group

Query Parameters
pageNo
integer

pageSize
integer

sortName
string

isDescendingOrder
boolean

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.address
(Optional) User address.
results.altEmail
results.authType
results.changePassword
results.city
(Optional) City name.
results.country
Country name. To get the list of countries, use Get Countries API.
results.createdTime
results.designation
(Optional) User designation.
results.email
Email of the user. (Alert and report notifications are sent to the email address.)
results.firstName
User first name.
results.id
results.lastName
User last name
results.loginName
User login name.
results.mobileNumber
(Optional) User mobile number.
results.orgId
results.organizationName
results.password
Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character
results.phoneNumber
(Optional) User phone number.
results.profileImage
results.roles
(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.
results.state
(Optional) State name.
results.status
results.timeZone
Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
results.updatedTime
results.userAccountType
(Optional) User account type: - REGULAR - BUSINESS
results.userGroupType
(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE
results.userGroups
(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.
results.userNotifications
(Optional) Email to which the alert and report notifications are sent.
results.zip
(Optional) Zip code.
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "email": "john.smith@myorganization.com",
      "firstName": "John",
      "id": "USR0000000029",
      "lastName": "Smith",
      "loginName": "john.smith"
    },
    {
      "email": "james.hudson@myorganization.com",
      "firstName": "James",
      "id": "USR0000000014",
      "lastName": "Hudson",
      "loginName": "james.hudson",
      "phoneNumber": "+805 123 1234"
    }
  ],
  "totalPages": 1,
  "totalResults": 2
}
Endpoint
/api/v2/tenants/{tenantId}/userGroups/{userGroupId}/users

Adds users to an existing user group.

Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

userGroupId
string

Unique Identifier (UUID) the user group

id
string

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

[
  {
    "id": "USR0000000029"
  },
  {
    "id": "USR0000000030"
  }
]

Responses

OK