Group Users API (1.0.0)

Download OpenAPI specification:

API documentation for managing users, bulk operations, and group-level permissions.

Users

List users in a group

Returns paginated list of users in the group with advanced filtering capabilities. All text filters (username, firstname, lastname, puid, rolename) support case-insensitive partial matching. Special keyword "-none-" for rolename returns users with no role assigned. Multiple filters can be combined using AND logic (default) or OR logic (orMode=true).

Required Permissions:

  • GROUP_OWNER role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group

query Parameters
username
string
offset
integer >= 0
Default: 0
limit
integer [ 1 .. 1000 ]
Default: 20
firstname
string
lastname
string
puid
string
rolename
string
roleId
string
orMode
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "usersList": [
    ]
}

Create users in a group

Create users in a group. A maximum of 1,000 users can be created per request. For larger imports, split into multiple requests of up to 1,000 users each.

Required Permissions (all required):

  • GROUP_OWNER role
  • GROUP_ADD_PERSON role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group

Request Body schema: application/json
required
Array (<= 1000 items)
firstName
string
lastName
string
email
string
phone
string
username
required
string
password
string
partnerUserId
required
string
roleId
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Update users in a group

Update users in a group. A maximum of 1,000 users can be updated per request. For larger batch updates, split into multiple requests of up to 1,000 users each.

Required Permissions (all required):

  • GROUP_OWNER role
  • GROUP_MODIFY_PERSON role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group

Request Body schema: application/json
required
Array (<= 1000 items)
userId
required
integer
partnerUserId
string
suspended
boolean
username
string
password
string
firstName
string
lastName
string
email
string
phone
string
roleId
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
0
0

Unlock the specified user in a group

Unlock the specified user in a group. Removes the login lockout that occurs after repeated failed authentication attempts. The user will be able to log in again immediately.

Required Permissions (any one):

  • ROOT role
  • GROUP_OWNER role
  • GROUP_MODIFY_PERSON role
  • MEMBER_SUBGROUP_PERMISSION role
  • CUSTOMER_SUBGROUP_PERMISSION role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete users in a group

Delete users in a group. A maximum of 1,000 users can be deleted per request. For larger batch deletions, split into multiple requests of up to 1,000 user IDs each.

Required Permissions (all required):

  • GROUP_OWNER role
  • GROUP_DELETE_PERSON role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer
Request Body schema: application/json
required

An array of user IDs to delete from the group.

Array (<= 1000 items)
integer

Responses

Request samples

Content type
application/json
[
  • 1001,
  • 1002,
  • 1003
]

Response samples

Content type
application/json
3

Get permissions of a user in a group

Returns the full set of group-level permissions for the specified user. Each permission is represented as a boolean value indicating whether it is granted.

Available permissions: groupOwner, addUsers, editUsers, deleteUsers, editGroupSettings, editSecurity, viewSecurity, manageCustomerSubgroups, manageMemberSubgroups.

Required Permissions:

  • GROUP_OWNER role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "groupOwner": true,
  • "addUsers": true,
  • "editUsers": true,
  • "deleteUsers": true,
  • "editGroupSettings": true,
  • "editSecurity": true,
  • "viewSecurity": true,
  • "manageCustomerSubgroups": true,
  • "manageMemberSubgroups": false
}

Set permissions of a user in a group

Updates group-level permissions for the specified user. Provide an object mapping permission names to boolean values.

Required Permissions (all required):

  • GROUP_OWNER role
  • SECURITY role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer
user_id
required
integer
Request Body schema: application/json
required
groupOwner
boolean
addUsers
boolean
editUsers
boolean
deleteUsers
boolean
editGroupSettings
boolean
editSecurity
boolean
viewSecurity
boolean
manageCustomerSubgroups
boolean
manageMemberSubgroups
boolean

Responses

Request samples

Content type
application/json
{
  • "addUsers": true,
  • "editUsers": true,
  • "deleteUsers": false
}

Response samples

Content type
application/json
3