API docs by Redocly

Users API (1.0.0)

Download OpenAPI specification:

Integrate Glance into your customer service workflows with secure, flexible APIs.

This suite of endpoints provides comprehensive administrative control over your account's users, including creation, bulk operations, status modifications (locks/suspensions), and group-level permissions.

Users

Get users in a group

Returns paginated list of users in the group.

Required Permissions:

  • GROUP_OWNER
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group

query Parameters
username
string

Filter by username (case-insensitive partial match). Example "john" matches "john.smith", "JOHN.DOE"

offset
integer >= 0
Default: 0

Position to start the page of results

limit
integer [ 1 .. 1000 ]
Default: 20

Number of results to return in the page (max 1000)

firstname
string

Filter by first name (case-insensitive partial match). Example "john" matches "John", "JOHNNY"

lastname
string

Filter by last name (case-insensitive partial match). Example "smith" matches "Smith", "SMITHSON"

puid
string

Filter by partner user ID (case-insensitive partial match). Example "abc" matches "ABC123", "xyz_abc_789"

rolename
string

Filter by role name (case-insensitive partial match). Special case: Use "-none-" (any case) to find users with no role assigned (roleId = 0 or NULL). Examples: "admin" matches "Administrator", "SystemAdmin"; "-none-" returns users with no role

roleId
string

Filter by exact role ID. Use "0" to find users with no role assigned (equivalent to rolename="-none-")

orMode
boolean
Default: false

Use OR logic for combining filters (default: false uses AND logic). When true, users matching ANY filter are returned; when false, users must match ALL filters

col
string
Default: "username"
Enum: "username" "firstname" "lastname" "person_id"

Column to sort by. Default username is effective login/Glance address (A–Z when sort=asc).

sort
string
Default: "asc"
Enum: "asc" "desc"

Sort direction for the column chosen by col.

lockedOut
boolean

When true, restrict results to login lockout users.

suspended
boolean

When true, restrict results to suspended users.

admin
boolean

When true, restrict results to group administrators (GROUP OWNER permission in this group).

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
  • GROUP_ADD_PERSON
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group

Request Body schema: application/json
required
Array (<= 1000 items)
firstName
string

User's first name.

lastName
string

User's last name.

email
string

User's email address.

username
required
string

User's username.

password
string

User's password.

partnerUserId
required
string

External system identifier associated with this user.

roleId
integer

Numeric identifier representing the user's assigned role within the group.

defaultGroupId
integer

Preferred group ID for login when the user has multiple affiliations.

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
  • GROUP_MODIFY_PERSON
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

The unique Glance identifier of the user. This value cannot be modified.

partnerUserId
string

External system identifier associated with this user.

suspended
boolean

Whether the user account is suspended. Set to true to suspend the user or false to reactivate.

username
string

User's username.

password
string

User's password.

firstName
string

User's first name.

lastName
string

User's last name.

email
string

User's email address.

roleId
integer

Numeric identifier representing the user's assigned role within the group. Set to 0 to remove the user's role assignment.

defaultGroupId
integer

Preferred group ID for login when the user has multiple affiliations. Set to 0 to clear.

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.

Required Permissions (any one):

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

The ID of the group the user belongs to.

user_id
required
integer

The ID of the locked user.

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
  • GROUP_DELETE_PERSON
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

The unique Glance identifier of the user.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

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.

Required Permissions:

  • GROUP_OWNER
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group to query permissions within.

user_id
required
integer

The ID of the user whose permissions to retrieve.

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.

Required Permissions (all required):

  • GROUP_OWNER
  • SECURITY
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group to update permissions within.

user_id
required
integer

The ID of the user whose permissions to update.

Request Body schema: application/json
required

Object mapping permission names to boolean values.

groupOwner
boolean

Whether the user has full group owner privileges, granting access to all group management capabilities.

addUsers
boolean

Whether the user can create new users within the group.

editUsers
boolean

Whether the user can modify existing user accounts within the group.

deleteUsers
boolean

Whether the user can remove users from the group.

editGroupSettings
boolean

Whether the user can modify group-level settings and configuration.

editSecurity
boolean

Whether the user can modify security settings and permission assignments for other users.

viewSecurity
boolean

Whether the user can view security settings and permission assignments (read-only access).

manageCustomerSubgroups
boolean

Whether the user can create, modify, and manage customer-type subgroups.

manageMemberSubgroups
boolean

Whether the user can create, modify, and manage member-type subgroups.

Request samples

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