Auth0 Node.js SDK - v5.1.0
    Preparing search index...

    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;
        organization_id?: string | null;
        tenant_name?: string;
        description?: string | null;
        created_at?: string;
        updated_at?: string;
        membership_created_at?: string;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    • Group
      • UserGroupsResponseSchema

    Indexable

    • [key: string]: any

      Accepts any additional properties

    Index

    Properties

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

    Properties

    id?: string

    Unique identifier for the group (service-generated).

    name?: string

    Name of the group. Must be unique within its scope (connection, organization, or tenant). Must contain between 1 and 128 printable ASCII characters.

    external_id?: string

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

    connection_id?: string

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

    organization_id?: string | null

    Identifier for the organization this group belongs to (if an organization group).

    tenant_name?: string

    Identifier for the tenant this group belongs to.

    description?: string | null
    created_at?: string

    Timestamp of when the group was created.

    updated_at?: string

    Timestamp of when the group was last updated.

    membership_created_at?: string

    Timestamp of when the group membership was added.

    Settings

    Member Visibility

    On This Page

    Properties