• Parameters

    • options: undefined | {
          query?: {
              statuses?: ("active" | "invited" | "pending" | "rejected" | "removed" | "left" | "declined")[];
          };
      } & {
          headers?: Headers;
          query?: {
              [key: string]: string | number | (string | number | null | undefined)[] | null | undefined;
          };
      } = {}
    • Optional sdkOptions: SDKOptions

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

Generated using TypeDoc