• Parameters

    • Optionaloptions: {
          query?: {
              statuses?: (
                  | "active"
                  | "invited"
                  | "pending"
                  | "rejected"
                  | "removed"
                  | "left"
                  | "declined")[];
          };
      } & BaseServiceMethodOptions
    • OptionalsdkOptions: SDKOptions

    Returns Promise<JSONFetchResponse<{
        allowed_actions?: null | {
            accept: string[];
            add: string[];
            approve: string[];
            change_role: string[];
            decline: string[];
            invite: string[];
            join: string[];
            leave: string[];
            reject: string[];
            remove: string[];
            request_join: string[];
        };
        child_ids?: null | string[];
        description?: null | string;
        enforce_session?: boolean;
        group_type?: "regular" | "plus";
        id: string;
        memberships?: null | {
            group_id: string;
            identity_id: string;
            invite_email_address?: null | string;
            invite_time?: null | string;
            membership_fields?: null | Record<string, unknown>;
            role: "manager" | "member" | "admin";
            source_group_id?: string;
            status:
                | "active"
                | "invited"
                | "pending"
                | "rejected"
                | "removed"
                | "left"
                | "declined";
            status_reason?: null | string;
            updated?: null | string;
            username: string;
        }[];
        my_memberships?: null | {
            group_id: string;
            identity_id: string;
            invite_email_address?: null | string;
            invite_time?: null | string;
            membership_fields?: null | Record<string, unknown>;
            role: "manager" | "member" | "admin";
            source_group_id?: string;
            status:
                | "active"
                | "invited"
                | "pending"
                | "rejected"
                | "removed"
                | "left"
                | "declined";
            status_reason?: null | string;
            updated?: null | string;
            username: string;
        }[];
        name: string;
        parent_id: null | string;
        policies?: {
            authentication_assurance_timeout?: null | number;
            group_members_visibility: "members" | "managers";
            group_visibility: "authenticated" | "private";
            is_high_assurance: boolean;
            join_requests?: boolean;
            signup_fields: (
                | "state"
                | "department"
                | "institution"
                | "current_project_name"
                | "address"
                | "city"
                | "country"
                | "address1"
                | "address2"
                | "zip"
                | "phone"
                | "field_of_science")[];
        };
        session_limit?: null | number;
        session_timeouts?: {
            [key: string]: components["schemas"]["TimeoutData"];
        };
        subscription_id?: null | string;
        subscription_info?: null | {
            connectors?: {
                [key: string]: components["schemas"]["ConnectorSubscriptionInfo"];
            };
            is_baa?: boolean;
            is_high_assurance?: boolean;
            name: string;
            subscriber_name?: null | string;
        };
        terms_and_conditions?: null | string;
    }[]>>