Function getGroup

getGroup(
    client: Client,
    parameters: { directoryId: string; id: string },
    options?: RequestOptions,
): Promise<
    {
        displayName?: string;
        externalId?: string;
        id?: string;
        members?: {
            $ref?: string;
            display?: string;
            type?: string;
            value?: string;
            [key: string]: unknown;
        }[];
        meta?: {
            created?: Date;
            lastModified?: Date;
            location?: string;
            resourceType?: string & {}
            | "USER"
            | "GROUP"
            | "DIRECTORY";
            [key: string]: unknown;
        };
        schemas?: string[];
        [key: string]: unknown;
    },
>
Gets the details of a group based on the id.
Parameters
- client: Client
- parameters: { directoryId: string; id: string }
  - directoryId: string
    
    The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
  - id: string
    
    Unique SCIM id that serves as reference to the group. Use the Get groups API to get the SCIM id.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        displayName?: string;
        externalId?: string;
        id?: string;
        members?: {
            $ref?: string;
            display?: string;
            type?: string;
            value?: string;
            [key: string]: unknown;
        }[];
        meta?: {
            created?: Date;
            lastModified?: Date;
            location?: string;
            resourceType?: string & {}
            | "USER"
            | "GROUP"
            | "DIRECTORY";
            [key: string]: unknown;
        };
        schemas?: string[];
        [key: string]: unknown;
    },
>
- Defined in src/userProvisioning/api/groups.ts:12

Function getGroup

Parameters

directoryId: string

id: string

Settings