Affiliations 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 user affiliations, allowing you to view, assign, and expire user affiliations across your organization's subgroups.

Users

Get user's group affiliations

Returns list of affiliations for a user within the scope of a group. External group affiliations are excluded.

Required Permissions:

  • GROUP_OWNER
Authorizations:
BearerAuth
path Parameters
group_id
required
integer <int64>

The ID of the parent group

user_id
required
integer <int64>

The ID of the user to get affiliations for

Responses

Response samples

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

Add user subgroup affiliations

Add affiliations connecting a user to one or more subgroups. Only subgroups of the parent group are allowed.

Required Permissions (all required):

  • GROUP_OWNER
  • GROUP_MODIFY_PERSON

Important: This endpoint only works from a top-level group. Calling from a subgroup will return error: "Cannot directly update affiliations of a user in a subgroup"

Authorizations:
BearerAuth
path Parameters
group_id
required
integer <int64>

The ID of the parent group (must be a top-level group)

user_id
required
integer <int64>

The ID of the user to add affiliations for

Request Body schema: application/json
required
Array ([ 1 .. 100 ] items)
integer <int64>

The ID of a subgroup to affiliate the user with.

Responses

Request samples

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

Response samples

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

Expire user subgroup affiliations

Expire affiliations for a user from one or more subgroups by setting the expiration date to the current date. Only subgroups of the parent group can be expired. This maintains the affiliation history while marking them as no longer active.

Required Permissions (all required):

  • GROUP_OWNER
  • GROUP_MODIFY_PERSON

Important: This endpoint only works from a top-level group. Calling from a subgroup will return error: "Cannot directly update affiliations of a user in a subgroup"

Authorizations:
BearerAuth
path Parameters
group_id
required
integer <int64>

The ID of the parent group (must be a top-level group)

user_id
required
integer <int64>

The ID of the user to expire affiliations for

Request Body schema: application/json
required
Array ([ 1 .. 100 ] items)
integer <int64>

The ID of a subgroup whose affiliation should be expired.

Responses

Request samples

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

Response samples

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