The Group object

The Group object represents a group that Lumos syncs from one of your connected apps, such as a group in Okta. Every group belongs to exactly one app, and its members are Lumos users. Groups are read-only in v1. You can list them, read one, and list its members.

The Group object

{
  "id": "4d5e6f70-8192-0123-def1-234567890123",
  "app_id": "2b3c4d5e-6f70-8901-bcde-f12345678901",
  "integration_specific_id": "00g1a2b3c4d5e6f7g8h9",
  "name": "Engineering",
  "description": "Everyone in the engineering org.",
  "group_lifecycle": "synced",
  "source_app_id": "okta.com"
}

Attributes

Field	Type	Description
`id`	string	Unique identifier for the group. Always present.
`app_id`	string	The `id` of the app the group is synced from. Always present.
`integration_specific_id`	string or null	The group’s own ID in that app, such as its Okta group ID.
`name`	string or null	The group’s name.
`description`	string or null	The group’s description.
`group_lifecycle`	string or null	`synced` or `native`. v1 returns `synced` for every group today.
`source_app_id`	string or null	The `app_class_id` of the integration behind the group’s app, such as `okta.com`.

app_id and source_app_id look alike but hold different things. app_id is the id of your app, the value you pass to Get App. source_app_id is the app_class_id of the app’s integration, which every app connected to that integration shares.

Filtering the list

List Groups returns groups sorted by name. Three filters narrow it:

Filter	Effect
`name`	Groups whose name contains this text. Add `exact_match=true` to match the whole name only.
`integration_specific_id`	Groups with this ID in their app.
`app_id`	Groups synced from one app.

An app_id that doesn’t match an app in your organization returns 404.

Permissions for listing and reading groups

Listing groups needs permission to read groups across your organization. Reading one group, through Get Group or List Group Members, needs permission to read that group. Of the built-in roles, Admin, Read Only Admin, App Admin, and AppStore Read Only Admin have both, so a user with only the User role gets 403 from all three.

Members

List Group Members returns the group’s members as user objects, sorted by given name. The list returns results in pages like every other v1 list, so read Pagination before you assume that one call returned every member.

Endpoints

Endpoint	Path
List Groups	`GET /v1/groups`
Get Group	`GET /v1/groups/{group_id}`
List Group Members	`GET /v1/groups/{group_id}/users`

Quick Start

Lumos API

API Reference

Guides

Migrate from v0

Lumos Connectors

Webhooks

Tools

The Group object

Attributes

Filtering the list

Permissions for listing and reading groups

Members

Endpoints

​Attributes

​Filtering the list

​Permissions for listing and reading groups

​Members

​Endpoints

Attributes

Filtering the list

Permissions for listing and reading groups

Members

Endpoints