API docs by Redocly

Subgroups 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 organizational structure, specifically managing the creation, modification, and disassociation of subgroups.

Subgroups

Returns list of subgroups of current group

Returns list of subgroups of current group.

Required Permissions:

  • GROUP_OWNER
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The group ID (Must be a positive unsigned integer)

Responses

Response samples

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

Creates a subgroup of the authenticated group

Create a subgroup within the authenticated group. A subgroup represents a child organization that inherits the parent group's feature configuration and can be managed independently. The authenticated group must be a top-level group. Nested subgroups are not supported.

Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The group ID (Must be a positive unsigned integer)

Request Body schema: application/json
required
name
required
string <= 100 characters

Display name for the subgroup (stored as group_name). Spaces and mixed case are allowed; maximum 100 characters.

apiKey
string <= 255 characters

Optional API key for the new subgroup. When omitted or empty, the server generates a unique 16-character alphanumeric key.

relationship
required
string

The relationship type to the parent group (case-insensitive). One of: CUSTOMER, MEMBER.

defaultBaseAddress
string

Optional default Glance address prefix for the new subgroup. When omitted or whitespace-only, default_base_address is not set on the new group row; the server may still derive a hostname from the display name for uniqueness checks only (same as before this field existed).

Responses

Request samples

Content type
application/json
{
  • "name": "West Region",
  • "apiKey": "string",
  • "relationship": "MEMBER",
  • "defaultBaseAddress": "string"
}

Response samples

Content type
application/json
{
  • "subgroupId": 12345,
  • "subgroupName": "Acme Corp",
  • "baseAddress": ".acme.glance.net",
  • "defaultBillingId": 11111
}

Update a subgroup's name and/or relationship

Update the details of a subgroup.

Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The parent group ID (Must be a positive unsigned integer)

subgroup_id
required
integer

The child subgroup ID to update (Must be a positive unsigned integer)

Request Body schema: application/json
required
name
string <= 100 characters

New display name for the subgroup (optional). Spaces allowed; maximum 100 characters after trim.

relationship
string

New relationship type to the parent group (case-insensitive). One of: 'CUSTOMER', 'MEMBER' (optional)

defaultBaseAddress
string

New default Glance address prefix for the subgroup (optional). Omitted or null leaves the current value unchanged.

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Subgroup Name",
  • "relationship": "CUSTOMER",
  • "defaultBaseAddress": "west-region.glance.net"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Subgroup updated successfully"
}

Disassociate a subgroup from it's parent group, turning the disassociated subgroup to a top-level group

Disassociate a subgroup from it's parent group, turning the disassociated subgroup to a top-level group. The parent group ID provided in group_id must be a top level group, and the direct parent of the subgroup ID provided in subgroup_id.

Required Permissions:

  • GROUP_OWNER
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The parent group ID (Must be a positive unsigned integer)

subgroup_id
required
integer

The child subgroup ID (Must be a positive unsigned integer)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Subgroup disconnected successfully"
}