API docs by Redocly

Glance Portal API - Users (0.1)

Download OpenAPI specification:Download

API endpoints for managing users

Users

APIs for accessing and modifying user information.

Returns a list of users

Get the users in a group. Some filters are available in the query string, and these will return any results with a partial substring match. Filters apply in an 'AND' fashion.

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

The number of results to return per page for pagination. The value must be an integer between 1 and 1000

offset
integer >= 0
Default: 0

The number of records to skip before starting to return results for pagination. The value must be an integer greater than or equal to 0

username
string

You may identify your subscribers by giving part of their Glance Addresses. If your subscribers have Glance Addresses like p123.example.glance.net, p124.example.glance.net, and p125.example.glance.net, you may identify them all by specifying .example.glance.net.To identify just one subscriber give the entire Glance Address. To get all subscribers omit this parameter or set to the empty string.

firstName
string

Supply a first name to filter results

lastName
string

Supply a last name to filter results

puid
string

Supply a Partner User ID to filter results. A PUID is a unique identifier for a user within a group.

roleName
string

Supply a role name to filter out users not associated with a role with a substring match for the supplied name

roleID
string

Supply a role ID to filter out users who do not have the specified roleID.

orMode
boolean

When pass in true to the orMode parameter, the filter parameters passed in will act in an "or"-like fashion, and will return any users that match any of the filters.

Responses

Response samples

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

Create new users

Create new users within a group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

Request Body schema: application/json
required
Array
firstName
string

The user's first name

lastName
string

The user's last name

email
string

The user's email

phone
string

The user's phone number

username
required
string

The user's username, formerly "Glance Address"

password
string

The user's password

partnerUserId
required
string

The user's partnerUserId, a unique identifier within this group

roleId
integer

The user's associated role ID in this group

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Update users

Update existing users within a group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

Request Body schema: application/json
required
Array
userId
required
integer

The user's unique ID

partnerUserId
string

The user's partnerUserId, a unique identifier within this group (Empty string is not allowed)

suspended
boolean

Set to true to suspend an active user, and set to false to reinstate a suspended user.

username
string

The user's username, formerly "Glance Address"

password
string

The user's password

firstName
string

The user's first name

lastName
string

The user's last name

email
string

The user's email

phone
string

The user's phone number

roleId
integer

The user's role ID

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
2

Delete users

Delete existing users within a group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

Request Body schema: application/json
required
Array
integer

Array of User IDs

Responses

Request samples

Content type
application/json
[
  • 100,
  • 200,
  • 300
]

Response samples

Content type
application/json
3