• management
• Management
• UserGroupsResponseSchema

Interface UserGroupsResponseSchema

Represents the metadata of a group. Member lists are retrieved via a separate endpoint.

interface UserGroupsResponseSchema {
id?: string;
name?: string;
external_id?: string;
connection_id?: string;
tenant_name?: string;
created_at?: string;
updated_at?: string;
membership_created_at?: string;
key: string: any;
}

Hierarchy (View Summary)

• Group
  • UserGroupsResponseSchema

Indexable

Accepts any additional properties

Index

Properties

id?name?external_id?connection_id?tenant_name?created_at?updated_at?membership_created_at?

Properties

Optionalid

id?: string

Unique identifier for the group (service-generated).

Optionalname

name?: string

Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters.

Optionalexternal_id

external_id?: string

External identifier for the group, often used for SCIM synchronization. Max length of 256 characters.

Optionalconnection_id

connection_id?: string

Identifier for the connection this group belongs to (if a connection group).

Optionaltenant_name

tenant_name?: string

Identifier for the tenant this group belongs to.

Optionalcreated_at

created_at?: string

Timestamp of when the group was created.

Optionalupdated_at

updated_at?: string

Timestamp of when the group was last updated.

Optionalmembership_created_at

membership_created_at?: string

Timestamp of when the group membership was added.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties idnameexternal_idconnection_idtenant_namecreated_atupdated_atmembership_created_at