Download OpenAPI specification:
API documentation for managing users, bulk operations, and group-level permissions.
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_id required | integer The ID of the group |
| 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 |
{- "pagination": {
- "offset": 0,
- "pageSize": 0,
- "totalRecords": 0
}, - "usersList": [
- {
- "userId": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "phone": "string",
- "username": "string",
- "partnerUserId": "string",
- "suspended": true,
- "locked": true,
- "subscription": true,
- "roleId": 0,
- "roleName": "string",
- "lastWebLogin": "string",
- "lastSession": "string",
- "administrator": true
}
]
}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_id required | integer The ID of the group |
| firstName | string |
| lastName | string |
string | |
| phone | string |
| username required | string |
| password | string |
| partnerUserId required | string |
| roleId | integer |
[- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "phone": "string",
- "username": "string",
- "password": "string",
- "partnerUserId": "string",
- "roleId": 0
}
][- {
- "userId": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "phone": "string",
- "username": "string",
- "partnerUserId": "string",
- "suspended": true,
- "roleId": 0
}
]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_id required | integer The ID of the group |
| userId required | integer |
| partnerUserId | string |
| suspended | boolean |
| username | string |
| password | string |
| firstName | string |
| lastName | string |
string | |
| phone | string |
| roleId | integer |
[- {
- "userId": 0,
- "partnerUserId": "string",
- "suspended": true,
- "username": "string",
- "password": "string",
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "phone": "string",
- "roleId": 0
}
]0Unlock 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):
| group_id required | integer |
| user_id required | integer |
{- "status": "ok"
}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_id required | integer |
An array of user IDs to delete from the group.
[- 1001,
- 1002,
- 1003
]3Returns 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_id required | integer |
| user_id required | integer |
{- "groupOwner": true,
- "addUsers": true,
- "editUsers": true,
- "deleteUsers": true,
- "editGroupSettings": true,
- "editSecurity": true,
- "viewSecurity": true,
- "manageCustomerSubgroups": true,
- "manageMemberSubgroups": false
}Updates group-level permissions for the specified user. Provide an object mapping permission names to boolean values.
Required Permissions (all required):
| group_id required | integer |
| user_id required | integer |
| groupOwner | boolean |
| addUsers | boolean |
| editUsers | boolean |
| deleteUsers | boolean |
| editGroupSettings | boolean |
| editSecurity | boolean |
| viewSecurity | boolean |
| manageCustomerSubgroups | boolean |
| manageMemberSubgroups | boolean |
{- "addUsers": true,
- "editUsers": true,
- "deleteUsers": false
}3