Globus SDK for JavaScript
    Preparing search index...

    Interface paths

    interface paths {
        "/v2/groups": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            description?: null
                            | string;
                            name: string;
                            parent_id?: null | string;
                            policies?: {
                                authentication_assurance_timeout?: null | number;
                                group_members_visibility?: null | "members" | "managers";
                                group_visibility?: null | "authenticated" | "private";
                                is_high_assurance?: null | boolean;
                                join_requests?: null | boolean;
                                signup_fields?:
                                    | null
                                    | (
                                        | "state"
                                        | "department"
                                        | "institution"
                                        | "current_project_name"
                                        | "address"
                                        | "city"
                                        | "country"
                                        | "address1"
                                        | "address2"
                                        | "zip"
                                        | "phone"
                                        | "field_of_science"
                                    )[];
                            };
                            terms_and_conditions?: null
                            | string;
                        };
                    };
                };
                responses: {
                    "201": {
                        content: {
                            "application/json": {
                                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 | { [key: ...]: ... };
                                        role: "manager" | "admin" | "member";
                                        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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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]: { expire_time: string; expires_in: number };
                                };
                                subscription_admin_verified_id?: null
                                | string;
                                subscription_id?: null | string;
                                subscription_info?:
                                    | null
                                    | {
                                        connectors: {
                                            [key: string]: { is_baa: boolean; is_ha: boolean };
                                        };
                                        is_baa: boolean;
                                        is_high_assurance: boolean;
                                        name: string;
                                        subscriber_name: string;
                                    };
                                terms_and_conditions?: null
                                | string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                ambiguous_identities: string[];
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/groups/{group_id}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                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 | { [key: ...]: ... };
                                        role: "manager" | "admin" | "member";
                                        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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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]: { expire_time: string; expires_in: number };
                                };
                                subscription_admin_verified_id?: null
                                | string;
                                subscription_id?: null | string;
                                subscription_info?:
                                    | null
                                    | {
                                        connectors: {
                                            [key: string]: { is_baa: boolean; is_ha: boolean };
                                        };
                                        is_baa: boolean;
                                        is_high_assurance: boolean;
                                        name: string;
                                        subscriber_name: string;
                                    };
                                terms_and_conditions?: null
                                | string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                ambiguous_identities: string[];
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: { include?: null | string[] };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                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 | { [key: ...]: ... };
                                        role: "manager" | "admin" | "member";
                                        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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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]: { expire_time: string; expires_in: number };
                                };
                                subscription_admin_verified_id?: null
                                | string;
                                subscription_id?: null | string;
                                subscription_info?:
                                    | null
                                    | {
                                        connectors: {
                                            [key: string]: { is_baa: boolean; is_ha: boolean };
                                        };
                                        is_baa: boolean;
                                        is_high_assurance: boolean;
                                        name: string;
                                        subscriber_name: string;
                                    };
                                terms_and_conditions?: null
                                | string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "community-context"?: null
                    | string };
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            accept?: | null
                            | { identity_id: string; status_reason?: null
                            | string }[];
                            add?:
                                | null
                                | {
                                    identity_id: string;
                                    role: null
                                    | "manager"
                                    | "admin"
                                    | "member";
                                    status_reason?: null | string;
                                }[];
                            approve?: | null
                            | { identity_id: string; status_reason?: null
                            | string }[];
                            change_role?:
                                | null
                                | {
                                    identity_id: string;
                                    role: null
                                    | "manager"
                                    | "admin"
                                    | "member";
                                }[];
                            decline?: | null
                            | { identity_id: string; status_reason?: null
                            | string }[];
                            invite?:
                                | null
                                | {
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    role: null | "manager" | "admin" | "member";
                                    status_reason?: null | string;
                                }[];
                            join?: null
                            | { identity_id: string }[];
                            leave?:
                                | null
                                | { identity_id: string; status_reason?: null
                                | string }[];
                            reject?:
                                | null
                                | { identity_id: string; status_reason?: null
                                | string }[];
                            remove?:
                                | null
                                | { identity_id: string; status_reason?: null
                                | string }[];
                            request_join?: null | { identity_id: string }[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                accept?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                add?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                approve?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                change_role?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                decline?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                errors?: | null
                                | {
                                    accept?: null
                                    | { code: ...; detail: ...; identity_id: ... }[];
                                    add?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    approve?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    change_role?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    decline?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    invite?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    join?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    leave?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    reject?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    remove?: null | { code: ...; detail: ...; identity_id: ... }[];
                                    request_join?: null | { code: ...; detail: ...; identity_id: ... }[];
                                };
                                invite?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                join?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                leave?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                reject?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                remove?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                                request_join?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: null
                                    | string;
                                    invite_time?: null | string;
                                    membership_fields: null | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    source_group_id?: string;
                                    status:
                                        | "active"
                                        | "invited"
                                        | "pending"
                                        | "rejected"
                                        | "removed"
                                        | "left"
                                        | "declined";
                                    status_reason?: null
                                    | string;
                                    updated?: null | string;
                                    username: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                ambiguous_identities: string[];
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "409": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            description?: null
                            | string;
                            name?: null | string;
                            subscription_admin_verified_id?: null | string;
                            terms_and_conditions?: null | string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                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 | { [key: ...]: ... };
                                        role: "manager" | "admin" | "member";
                                        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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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]: { expire_time: string; expires_in: number };
                                };
                                subscription_admin_verified_id?: null
                                | string;
                                subscription_id?: null | string;
                                subscription_info?:
                                    | null
                                    | {
                                        connectors: {
                                            [key: string]: { is_baa: boolean; is_ha: boolean };
                                        };
                                        is_baa: boolean;
                                        is_high_assurance: boolean;
                                        name: string;
                                        subscriber_name: string;
                                    };
                                terms_and_conditions?: null
                                | string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/v2/groups/{group_id}/children": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: { include?: null | string[] };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                children: {
                                    allowed_actions?: | null
                                    | {
                                        accept: (...)[];
                                        add: (...)[];
                                        approve: (...)[];
                                        change_role: (...)[];
                                        decline: (...)[];
                                        invite: (...)[];
                                        join: (...)[];
                                        leave: (...)[];
                                        reject: (...)[];
                                        remove: (...)[];
                                        request_join: (...)[];
                                    };
                                    child_ids?: null
                                    | string[];
                                    description?: null | string;
                                    enforce_session: boolean;
                                    group_type: "regular" | "plus";
                                    id: string;
                                    memberships?:
                                        | null
                                        | {
                                            group_id: ...;
                                            identity_id: ...;
                                            invite_email_address?: ...;
                                            invite_time?: ...;
                                            membership_fields: ...;
                                            role: ...;
                                            source_group_id?: ...;
                                            status: ...;
                                            status_reason?: ...;
                                            updated?: ...;
                                            username: ...;
                                        }[];
                                    my_memberships?: | null
                                    | {
                                        group_id: ...;
                                        identity_id: ...;
                                        invite_email_address?: ...;
                                        invite_time?: ...;
                                        membership_fields: ...;
                                        role: ...;
                                        source_group_id?: ...;
                                        status: ...;
                                        status_reason?: ...;
                                        updated?: ...;
                                        username: ...;
                                    }[];
                                    name: string;
                                    parent_id: null
                                    | string;
                                    policies?: {
                                        authentication_assurance_timeout?: (...) | (...) | (...);
                                        group_members_visibility: (...) | (...);
                                        group_visibility: (...) | (...);
                                        is_high_assurance: boolean;
                                        join_requests?: (...) | (...) | (...);
                                        signup_fields: (...)[];
                                    };
                                    session_limit?: null
                                    | number;
                                    session_timeouts: {
                                        [key: string]: { expire_time: string; expires_in: number };
                                    };
                                    subscription_admin_verified_id?: null
                                    | string;
                                    subscription_id?: null | string;
                                    subscription_info?:
                                        | null
                                        | {
                                            connectors: { [key: ...]: ... };
                                            is_baa: boolean;
                                            is_high_assurance: boolean;
                                            name: string;
                                            subscriber_name: string;
                                        };
                                    terms_and_conditions?: null
                                    | string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/groups/{group_id}/membership_fields": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                [key: string]: {
                                    address?: null
                                    | string;
                                    address1?: null | string;
                                    address2?: null | string;
                                    city?: null | string;
                                    country?: null | string;
                                    current_project_name?: null | string;
                                    department?: null | string;
                                    field_of_science?: null | string;
                                    first_name?: null | string;
                                    institution?: null | string;
                                    last_name?: null | string;
                                    organization?: null | string;
                                    phone?: null | string;
                                    state?: null | string;
                                    zip?: null | string;
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            [key: string]: {
                                address?: null
                                | string;
                                address1?: null | string;
                                address2?: null | string;
                                city?: null | string;
                                country?: null | string;
                                current_project_name?: null | string;
                                department?: null | string;
                                field_of_science?: null | string;
                                first_name?: null | string;
                                institution?: null | string;
                                last_name?: null | string;
                                organization?: null | string;
                                phone?: null | string;
                                state?: null | string;
                                zip?: null | string;
                            };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                [key: string]: {
                                    address?: null
                                    | string;
                                    address1?: null | string;
                                    address2?: null | string;
                                    city?: null | string;
                                    country?: null | string;
                                    current_project_name?: null | string;
                                    department?: null | string;
                                    field_of_science?: null | string;
                                    first_name?: null | string;
                                    institution?: null | string;
                                    last_name?: null | string;
                                    organization?: null | string;
                                    phone?: null | string;
                                    state?: null | string;
                                    zip?: null | string;
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/v2/groups/{group_id}/policies": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                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"
                                )[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            authentication_assurance_timeout?: null
                            | number;
                            group_members_visibility?: null | "members" | "managers";
                            group_visibility?: null | "authenticated" | "private";
                            is_high_assurance?: null | boolean;
                            join_requests?: null | boolean;
                            signup_fields?:
                                | null
                                | (
                                    | "state"
                                    | "department"
                                    | "institution"
                                    | "current_project_name"
                                    | "address"
                                    | "city"
                                    | "country"
                                    | "address1"
                                    | "address2"
                                    | "zip"
                                    | "phone"
                                    | "field_of_science"
                                )[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                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"
                                )[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/v2/groups/{group_id}/subscription_admin_verified": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { group_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            subscription_admin_verified_id: null
                            | string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                group_id: string;
                                subscription_admin_verified_id: null
                                | string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/v2/groups/my_groups": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: { statuses?: string[] };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                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?: (...)
                                        | (...)
                                        | (...);
                                        invite_time?: (...) | (...) | (...);
                                        membership_fields: (...) | (...);
                                        role: (...) | (...) | (...);
                                        source_group_id?: (...) | (...);
                                        status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        status_reason?: (...) | (...) | (...);
                                        updated?: (...) | (...) | (...);
                                        username: string;
                                    }[];
                                my_memberships?: | null
                                | {
                                    group_id: string;
                                    identity_id: string;
                                    invite_email_address?: (...)
                                    | (...)
                                    | (...);
                                    invite_time?: (...) | (...) | (...);
                                    membership_fields: (...) | (...);
                                    role: (...) | (...) | (...);
                                    source_group_id?: (...) | (...);
                                    status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                    status_reason?: (...) | (...) | (...);
                                    updated?: (...) | (...) | (...);
                                    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: (
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                    )[];
                                };
                                session_limit?: null
                                | number;
                                session_timeouts: {
                                    [key: string]: { expire_time: string; expires_in: number };
                                };
                                subscription_admin_verified_id?: null
                                | string;
                                subscription_id?: null | string;
                                subscription_info?:
                                    | null
                                    | {
                                        connectors: { [key: string]: { is_baa: ...; is_ha: ... } };
                                        is_baa: boolean;
                                        is_high_assurance: boolean;
                                        name: string;
                                        subscriber_name: string;
                                    };
                                terms_and_conditions?: null
                                | string;
                            }[];
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/groups/statuses": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                [key: string]: {
                                    active: number;
                                    declined: number;
                                    invited: number;
                                    left: number;
                                    pending: number;
                                    rejected: number;
                                    removed: number;
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/preferences": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                [key: string]: { allow_add: null
                                | boolean };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": { [key: string]: { allow_add: null
                        | boolean } };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                [key: string]: { allow_add: null
                                | boolean };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/v2/subscription_info/{subscription_id}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { subscription_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                group_id: string;
                                subscription_id: string;
                                subscription_info: {
                                    connectors: {
                                        [key: string]: { is_baa: boolean; is_ha: boolean };
                                    };
                                    is_baa: boolean;
                                    is_high_assurance: boolean;
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                authorization_parameters: {
                                    extra?: { [key: string]: unknown };
                                    required_scopes?: string[];
                                    session_message?: string;
                                    session_required_identities?: string[];
                                    session_required_mfa?: boolean;
                                    session_required_policies?: string[];
                                    session_required_single_domain?: string[];
                                };
                                code: string;
                                detail: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                detail: string;
                                provided_scopes?: null
                                | string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { code: string; detail: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
    }
    Index

    Properties

    /v2/groups /v2/groups/{group_id} /v2/groups/{group_id}/children /v2/groups/{group_id}/membership_fields /v2/groups/{group_id}/policies /v2/groups/{group_id}/subscription_admin_verified /v2/groups/my_groups /v2/groups/statuses /v2/preferences /v2/subscription_info/{subscription_id}

    Properties

    "/v2/groups": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        description?: null
                        | string;
                        name: string;
                        parent_id?: null | string;
                        policies?: {
                            authentication_assurance_timeout?: null | number;
                            group_members_visibility?: null | "members" | "managers";
                            group_visibility?: null | "authenticated" | "private";
                            is_high_assurance?: null | boolean;
                            join_requests?: null | boolean;
                            signup_fields?:
                                | null
                                | (
                                    | "state"
                                    | "department"
                                    | "institution"
                                    | "current_project_name"
                                    | "address"
                                    | "city"
                                    | "country"
                                    | "address1"
                                    | "address2"
                                    | "zip"
                                    | "phone"
                                    | "field_of_science"
                                )[];
                        };
                        terms_and_conditions?: null
                        | string;
                    };
                };
            };
            responses: {
                "201": {
                    content: {
                        "application/json": {
                            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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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]: { expire_time: string; expires_in: number };
                            };
                            subscription_admin_verified_id?: null
                            | string;
                            subscription_id?: null | string;
                            subscription_info?:
                                | null
                                | {
                                    connectors: {
                                        [key: string]: { is_baa: boolean; is_ha: boolean };
                                    };
                                    is_baa: boolean;
                                    is_high_assurance: boolean;
                                    name: string;
                                    subscriber_name: string;
                                };
                            terms_and_conditions?: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            ambiguous_identities: string[];
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      description?: null
                      | string;
                      name: string;
                      parent_id?: null | string;
                      policies?: {
                          authentication_assurance_timeout?: null | number;
                          group_members_visibility?: null | "members" | "managers";
                          group_visibility?: null | "authenticated" | "private";
                          is_high_assurance?: null | boolean;
                          join_requests?: null | boolean;
                          signup_fields?:
                              | null
                              | (
                                  | "state"
                                  | "department"
                                  | "institution"
                                  | "current_project_name"
                                  | "address"
                                  | "city"
                                  | "country"
                                  | "address1"
                                  | "address2"
                                  | "zip"
                                  | "phone"
                                  | "field_of_science"
                              )[];
                      };
                      terms_and_conditions?: null
                      | string;
                  };
              };
          };
          responses: {
              "201": {
                  content: {
                      "application/json": {
                          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 | { [key: ...]: ... };
                                  role: "manager" | "admin" | "member";
                                  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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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]: { expire_time: string; expires_in: number };
                          };
                          subscription_admin_verified_id?: null
                          | string;
                          subscription_id?: null | string;
                          subscription_info?:
                              | null
                              | {
                                  connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                  is_baa: boolean;
                                  is_high_assurance: boolean;
                                  name: string;
                                  subscriber_name: string;
                              };
                          terms_and_conditions?: null
                          | string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          ambiguous_identities: string[];
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create a new group

      MVP limitations:

      - For users with more than one linked identity, ability to specify
which identity becomes the admin will be added later.
- Non-default policies can not be specified. They can be adjusted using the
Globus web app.

Create a new group with the given name. The effective identity (typically
the user's primary identity) of the Auth token used for the call will be
added to the group as an administrator. The group will be created with
default polices that:

* Allow membership requests only to be approved by admins and managers
* Allow subgroups to be created only by admins
* Allow the group to be visible only to members
* Allow member names to be visible only to managers and admins
* Allow invititations to be sent by managers and admins
* Disallow requests to join

Groups can only be created by users with 1000 or fewer active memberships.
      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    description?: null | string;
                    name: string;
                    parent_id?: null | string;
                    policies?: {
                        authentication_assurance_timeout?: null | number;
                        group_members_visibility?: null | "members" | "managers";
                        group_visibility?: null | "authenticated" | "private";
                        is_high_assurance?: null | boolean;
                        join_requests?: null | boolean;
                        signup_fields?:
                            | null
                            | (
                                | "state"
                                | "department"
                                | "institution"
                                | "current_project_name"
                                | "address"
                                | "city"
                                | "country"
                                | "address1"
                                | "address2"
                                | "zip"
                                | "phone"
                                | "field_of_science"
                            )[];
                    };
                    terms_and_conditions?: null
                    | string;
                };
            };
        }
      • responses: {
            "201": {
                content: {
                    "application/json": {
                        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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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 | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            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]: { expire_time: string; expires_in: number };
                        };
                        subscription_admin_verified_id?: null
                        | string;
                        subscription_id?: null | string;
                        subscription_info?:
                            | null
                            | {
                                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                is_baa: boolean;
                                is_high_assurance: boolean;
                                name: string;
                                subscriber_name: string;
                            };
                        terms_and_conditions?: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        ambiguous_identities: string[];
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 201: {
              content: {
                  "application/json": {
                      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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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 | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          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]: { expire_time: string; expires_in: number };
                      };
                      subscription_admin_verified_id?: null
                      | string;
                      subscription_id?: null | string;
                      subscription_info?:
                          | null
                          | {
                              connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                              is_baa: boolean;
                              is_high_assurance: boolean;
                              name: string;
                              subscriber_name: string;
                          };
                      terms_and_conditions?: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 400: {
              content: {
                  "application/json": {
                      ambiguous_identities: string[];
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/groups/{group_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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]: { expire_time: string; expires_in: number };
                            };
                            subscription_admin_verified_id?: null
                            | string;
                            subscription_id?: null | string;
                            subscription_info?:
                                | null
                                | {
                                    connectors: {
                                        [key: string]: { is_baa: boolean; is_ha: boolean };
                                    };
                                    is_baa: boolean;
                                    is_high_assurance: boolean;
                                    name: string;
                                    subscriber_name: string;
                                };
                            terms_and_conditions?: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            ambiguous_identities: string[];
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: { include?: null | string[] };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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]: { expire_time: string; expires_in: number };
                            };
                            subscription_admin_verified_id?: null
                            | string;
                            subscription_id?: null | string;
                            subscription_info?:
                                | null
                                | {
                                    connectors: {
                                        [key: string]: { is_baa: boolean; is_ha: boolean };
                                    };
                                    is_baa: boolean;
                                    is_high_assurance: boolean;
                                    name: string;
                                    subscriber_name: string;
                                };
                            terms_and_conditions?: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "community-context"?: null
                | string };
                path: { group_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        accept?: | null
                        | { identity_id: string; status_reason?: null
                        | string }[];
                        add?:
                            | null
                            | {
                                identity_id: string;
                                role: null
                                | "manager"
                                | "admin"
                                | "member";
                                status_reason?: null | string;
                            }[];
                        approve?: | null
                        | { identity_id: string; status_reason?: null
                        | string }[];
                        change_role?:
                            | null
                            | { identity_id: string; role: null
                            | "manager"
                            | "admin"
                            | "member" }[];
                        decline?:
                            | null
                            | { identity_id: string; status_reason?: null
                            | string }[];
                        invite?:
                            | null
                            | {
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                role: null | "manager" | "admin" | "member";
                                status_reason?: null | string;
                            }[];
                        join?: null
                        | { identity_id: string }[];
                        leave?: null | { identity_id: string; status_reason?: null | string }[];
                        reject?:
                            | null
                            | { identity_id: string; status_reason?: null
                            | string }[];
                        remove?:
                            | null
                            | { identity_id: string; status_reason?: null
                            | string }[];
                        request_join?: null | { identity_id: string }[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            accept?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            add?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            approve?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            change_role?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            decline?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            errors?: | null
                            | {
                                accept?: null
                                | { code: ...; detail: ...; identity_id: ... }[];
                                add?: null | { code: ...; detail: ...; identity_id: ... }[];
                                approve?: null | { code: ...; detail: ...; identity_id: ... }[];
                                change_role?: null | { code: ...; detail: ...; identity_id: ... }[];
                                decline?: null | { code: ...; detail: ...; identity_id: ... }[];
                                invite?: null | { code: ...; detail: ...; identity_id: ... }[];
                                join?: null | { code: ...; detail: ...; identity_id: ... }[];
                                leave?: null | { code: ...; detail: ...; identity_id: ... }[];
                                reject?: null | { code: ...; detail: ...; identity_id: ... }[];
                                remove?: null | { code: ...; detail: ...; identity_id: ... }[];
                                request_join?: null | { code: ...; detail: ...; identity_id: ... }[];
                            };
                            invite?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            join?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            leave?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            reject?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            remove?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                            request_join?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            ambiguous_identities: string[];
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "409": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        description?: null
                        | string;
                        name?: null | string;
                        subscription_admin_verified_id?: null | string;
                        terms_and_conditions?: null | string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            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 | { [key: ...]: ... };
                                    role: "manager" | "admin" | "member";
                                    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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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]: { expire_time: string; expires_in: number };
                            };
                            subscription_admin_verified_id?: null
                            | string;
                            subscription_id?: null | string;
                            subscription_info?:
                                | null
                                | {
                                    connectors: {
                                        [key: string]: { is_baa: boolean; is_ha: boolean };
                                    };
                                    is_baa: boolean;
                                    is_high_assurance: boolean;
                                    name: string;
                                    subscriber_name: string;
                                };
                            terms_and_conditions?: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          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 | { [key: ...]: ... };
                                  role: "manager" | "admin" | "member";
                                  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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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]: { expire_time: string; expires_in: number };
                          };
                          subscription_admin_verified_id?: null
                          | string;
                          subscription_id?: null | string;
                          subscription_info?:
                              | null
                              | {
                                  connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                  is_baa: boolean;
                                  is_high_assurance: boolean;
                                  name: string;
                                  subscriber_name: string;
                              };
                          terms_and_conditions?: null
                          | string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          ambiguous_identities: string[];
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Delete a group

      This endpoint allows a group to be deleted by an admin.

      > Note: Groups can only be deleted by admins.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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 | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            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]: { expire_time: string; expires_in: number };
                        };
                        subscription_admin_verified_id?: null
                        | string;
                        subscription_id?: null | string;
                        subscription_info?:
                            | null
                            | {
                                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                is_baa: boolean;
                                is_high_assurance: boolean;
                                name: string;
                                subscriber_name: string;
                            };
                        terms_and_conditions?: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        ambiguous_identities: string[];
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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 | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          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]: { expire_time: string; expires_in: number };
                      };
                      subscription_admin_verified_id?: null
                      | string;
                      subscription_id?: null | string;
                      subscription_info?:
                          | null
                          | {
                              connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                              is_baa: boolean;
                              is_high_assurance: boolean;
                              name: string;
                              subscriber_name: string;
                          };
                      terms_and_conditions?: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 400: {
              content: {
                  "application/json": {
                      ambiguous_identities: string[];
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: { include?: null | string[] };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          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 | { [key: ...]: ... };
                                  role: "manager" | "admin" | "member";
                                  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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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]: { expire_time: string; expires_in: number };
                          };
                          subscription_admin_verified_id?: null
                          | string;
                          subscription_id?: null | string;
                          subscription_info?:
                              | null
                              | {
                                  connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                  is_baa: boolean;
                                  is_high_assurance: boolean;
                                  name: string;
                                  subscriber_name: string;
                              };
                          terms_and_conditions?: null
                          | string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Group

      Get details and members of a group by group id.

      If `memberships` or `my_memberships` are in the `include` parameter and the
scopes in the provided authorization token allow memberships to be viewed,
the memberships will be returned in the response.

If `allowed_actions` are in the `include` parameter, and the scopes in the
tokens allow managing memberships, an object will be returned detailing which
membership actions each identity in the user's set is allowed to perform.

A group can be viewed if:
- The group policy is that any authenticated user can view it.
- The group is private, and the user has an active/invited/pending membership.

Group memberships can only be viewed by active members. Depending on group policy,
this may be further restricted to only admins and managers. Note that future
versions may relax this restriction for specific cases, such as allowing invited
or pending members to view the membership of the user that invited them.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: { include?: null | string[] };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { group_id: string }
        • Optionalquery?: { include?: null | string[] }
          • Optionalinclude?: null | string[]

            Form encoded or comma separated list of additional fields to include (allowed fields are memberships, my_memberships,policies, allowed_actions, and child_ids )

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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 | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            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]: { expire_time: string; expires_in: number };
                        };
                        subscription_admin_verified_id?: null
                        | string;
                        subscription_id?: null | string;
                        subscription_info?:
                            | null
                            | {
                                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                is_baa: boolean;
                                is_high_assurance: boolean;
                                name: string;
                                subscriber_name: string;
                            };
                        terms_and_conditions?: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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 | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          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]: { expire_time: string; expires_in: number };
                      };
                      subscription_admin_verified_id?: null
                      | string;
                      subscription_id?: null | string;
                      subscription_info?:
                          | null
                          | {
                              connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                              is_baa: boolean;
                              is_high_assurance: boolean;
                              name: string;
                              subscriber_name: string;
                          };
                      terms_and_conditions?: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "community-context"?: null | string };
              path: { group_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      accept?: | null
                      | { identity_id: string; status_reason?: null
                      | string }[];
                      add?:
                          | null
                          | {
                              identity_id: string;
                              role: null
                              | "manager"
                              | "admin"
                              | "member";
                              status_reason?: null | string;
                          }[];
                      approve?: | null
                      | { identity_id: string; status_reason?: null
                      | string }[];
                      change_role?:
                          | null
                          | { identity_id: string; role: null
                          | "manager"
                          | "admin"
                          | "member" }[];
                      decline?:
                          | null
                          | { identity_id: string; status_reason?: null
                          | string }[];
                      invite?:
                          | null
                          | {
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              role: null | "manager" | "admin" | "member";
                              status_reason?: null | string;
                          }[];
                      join?: null
                      | { identity_id: string }[];
                      leave?: null | { identity_id: string; status_reason?: null | string }[];
                      reject?: null | { identity_id: string; status_reason?: null | string }[];
                      remove?: null | { identity_id: string; status_reason?: null | string }[];
                      request_join?: null | { identity_id: string }[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          accept?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          add?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          approve?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          change_role?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          decline?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          errors?: | null
                          | {
                              accept?: null
                              | { code: ...; detail: ...; identity_id: ... }[];
                              add?: null | { code: ...; detail: ...; identity_id: ... }[];
                              approve?: null | { code: ...; detail: ...; identity_id: ... }[];
                              change_role?: null | { code: ...; detail: ...; identity_id: ... }[];
                              decline?: null | { code: ...; detail: ...; identity_id: ... }[];
                              invite?: null | { code: ...; detail: ...; identity_id: ... }[];
                              join?: null | { code: ...; detail: ...; identity_id: ... }[];
                              leave?: null | { code: ...; detail: ...; identity_id: ... }[];
                              reject?: null | { code: ...; detail: ...; identity_id: ... }[];
                              remove?: null | { code: ...; detail: ...; identity_id: ... }[];
                              request_join?: null | { code: ...; detail: ...; identity_id: ... }[];
                          };
                          invite?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          join?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          leave?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          reject?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          remove?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                          request_join?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          ambiguous_identities: string[];
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "409": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Perform actions on members of the group.

      This endpoint supports bulk actions on collections of members of the group. Currently the following actions are supported:

      - **accept**: Identities in the `accept` list which are in the users identity set
  will be accepted into the group. Only `invited` memberships can `accept`.
- **add**: Identities in the `add` list will be added to the group as long
  as the identity exists and they have not previously left the group, or indicated
  via settings that they can not be added to any group. Adding an identity which
  already have an active membership in the group will not modify the membership,
  and is an error for informational purposes. All active admins and managers are
  permitted to add members to a group. Active admins are also permitted to add
  admins and managers to a group.  Role is an optional parameter to set the
  membership role on addition.
- **approve**: Identities in the `approve` list will be
  accepted into the group. Only `pending` memberships can be included in
  the `approve` list. All active admins and managers are permitted to approve
  pending members to a group.
- **change_role**: Identities in the `change_role` list whose roles in the group are
  to be updated.  Only admins can change member roles.  Only `active` memberships
  are eligible for role changes.
- **decline**: Identities in the `decline` list which are in the users identity set
  will be rejected from the group. Only `invited` memberships can `decline`.
- **invite**:  Identities in the `invite` list will be invited to join the group.
  All active admins and managers are permitted to invite members to a group. Members
  may also invite other members if the policy allows it. Role is an optional
  parameter to set the membership role on invitation.
- **join**: Identities in the `join` list which are in the users identity set
  will join the group, if the group policy is to allow users to join. High Assurance
  groups cannot use this action.
- **leave**: Identities in the `leave` list which are in the users identity set
  will be removed from the group. Only `active` memberships can `leave`. If the
  identity is the last remaining `admin` of the group leaving is not allowed,
  since this would leave the group in an orphaned state.
- **reject**: Identities in the `reject` list will be
  rejected from the group. Only `pending` memberships can be included in
  the `reject` list. All active admins and managers are permitted to reject pending
  members from a group.
- **remove**: Identities in the `remove` list will be removed from the group.
  Admins can remove admins, managers, and members. Managers can remove managers and
  members. Regular members cannot remove any members. Only `active` and `invited`
  memberships can be removed, and users cannot remove their own memberships.
- **request_join**: Identities in the `request_join` list which are in the users
  identity set will be set as pending memberships for the group if the group policy
  requires membership approval. Pending memberships must be approved or rejected by
  administrators or managers.

The response will include the current state of any membership that was
successfully processed. The response will also include a list of errors
indicating the identity of any requested membership action that failed to
be processed.

Identity IDs must be unique across all actions in the same call. For example,
trying to add and remove the same identity in the same request will cause the
entire request to fail.
      • parameters: {
            cookie?: undefined;
            header?: { "community-context"?: null | string };
            path: { group_id: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    accept?:
                        | null
                        | { identity_id: string; status_reason?: null
                        | string }[];
                    add?:
                        | null
                        | {
                            identity_id: string;
                            role: null
                            | "manager"
                            | "admin"
                            | "member";
                            status_reason?: null | string;
                        }[];
                    approve?: null
                    | { identity_id: string; status_reason?: null | string }[];
                    change_role?:
                        | null
                        | { identity_id: string; role: null
                        | "manager"
                        | "admin"
                        | "member" }[];
                    decline?: null | { identity_id: string; status_reason?: null | string }[];
                    invite?:
                        | null
                        | {
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            role: null | "manager" | "admin" | "member";
                            status_reason?: null | string;
                        }[];
                    join?: null
                    | { identity_id: string }[];
                    leave?: null | { identity_id: string; status_reason?: null | string }[];
                    reject?: null | { identity_id: string; status_reason?: null | string }[];
                    remove?: null | { identity_id: string; status_reason?: null | string }[];
                    request_join?: null | { identity_id: string }[];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        accept?:
                            | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: null
                                | string;
                                invite_time?: null | string;
                                membership_fields: null | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                source_group_id?: string;
                                status:
                                    | "active"
                                    | "invited"
                                    | "pending"
                                    | "rejected"
                                    | "removed"
                                    | "left"
                                    | "declined";
                                status_reason?: null
                                | string;
                                updated?: null | string;
                                username: string;
                            }[];
                        add?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        approve?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        change_role?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        decline?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        errors?: | null
                        | {
                            accept?: null
                            | { code: ...; detail: ...; identity_id: ... }[];
                            add?: null | { code: ...; detail: ...; identity_id: ... }[];
                            approve?: null | { code: ...; detail: ...; identity_id: ... }[];
                            change_role?: null | { code: ...; detail: ...; identity_id: ... }[];
                            decline?: null | { code: ...; detail: ...; identity_id: ... }[];
                            invite?: null | { code: ...; detail: ...; identity_id: ... }[];
                            join?: null | { code: ...; detail: ...; identity_id: ... }[];
                            leave?: null | { code: ...; detail: ...; identity_id: ... }[];
                            reject?: null | { code: ...; detail: ...; identity_id: ... }[];
                            remove?: null | { code: ...; detail: ...; identity_id: ... }[];
                            request_join?: null | { code: ...; detail: ...; identity_id: ... }[];
                        };
                        invite?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        join?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        leave?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        reject?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        remove?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                        request_join?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            invite_time?: null | string;
                            membership_fields: null | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            source_group_id?: string;
                            status:
                                | "active"
                                | "invited"
                                | "pending"
                                | "rejected"
                                | "removed"
                                | "left"
                                | "declined";
                            status_reason?: null
                            | string;
                            updated?: null | string;
                            username: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        ambiguous_identities: string[];
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      accept?:
                          | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: null
                              | string;
                              invite_time?: null | string;
                              membership_fields: null | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              source_group_id?: string;
                              status:
                                  | "active"
                                  | "invited"
                                  | "pending"
                                  | "rejected"
                                  | "removed"
                                  | "left"
                                  | "declined";
                              status_reason?: null
                              | string;
                              updated?: null | string;
                              username: string;
                          }[];
                      add?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      approve?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      change_role?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      decline?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      errors?: | null
                      | {
                          accept?: null
                          | { code: ...; detail: ...; identity_id: ... }[];
                          add?: null | { code: ...; detail: ...; identity_id: ... }[];
                          approve?: null | { code: ...; detail: ...; identity_id: ... }[];
                          change_role?: null | { code: ...; detail: ...; identity_id: ... }[];
                          decline?: null | { code: ...; detail: ...; identity_id: ... }[];
                          invite?: null | { code: ...; detail: ...; identity_id: ... }[];
                          join?: null | { code: ...; detail: ...; identity_id: ... }[];
                          leave?: null | { code: ...; detail: ...; identity_id: ... }[];
                          reject?: null | { code: ...; detail: ...; identity_id: ... }[];
                          remove?: null | { code: ...; detail: ...; identity_id: ... }[];
                          request_join?: null | { code: ...; detail: ...; identity_id: ... }[];
                      };
                      invite?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      join?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      leave?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      reject?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      remove?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                      request_join?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          A list of the changed memberships and a list of errors that occurred

        • 400: {
              content: {
                  "application/json": {
                      ambiguous_identities: string[];
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 409: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Conflict

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      description?: null
                      | string;
                      name?: null | string;
                      subscription_admin_verified_id?: null | string;
                      terms_and_conditions?: null | string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          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 | { [key: ...]: ... };
                                  role: "manager" | "admin" | "member";
                                  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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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]: { expire_time: string; expires_in: number };
                          };
                          subscription_admin_verified_id?: null
                          | string;
                          subscription_id?: null | string;
                          subscription_info?:
                              | null
                              | {
                                  connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                  is_baa: boolean;
                                  is_high_assurance: boolean;
                                  name: string;
                                  subscriber_name: string;
                              };
                          terms_and_conditions?: null
                          | string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Update an existing group

      Update the details of a group by group id.

      If `allowed_actions` are in the `include` parameter, and the scopes in the
tokens allow managing memberships, an object will be returned detailing which
membership actions each identity in the user's set is allowed to perform.

A group can be updated if:
- The user is an admin.

Group memberships should be updated using the membership endpoint.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    description?: null | string;
                    name?: null | string;
                    subscription_admin_verified_id?: null | string;
                    terms_and_conditions?: null | string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        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 | { [key: ...]: ... };
                                role: "manager" | "admin" | "member";
                                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 | { [key: ...]: ... };
                            role: "manager" | "admin" | "member";
                            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]: { expire_time: string; expires_in: number };
                        };
                        subscription_admin_verified_id?: null
                        | string;
                        subscription_id?: null | string;
                        subscription_info?:
                            | null
                            | {
                                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                is_baa: boolean;
                                is_high_assurance: boolean;
                                name: string;
                                subscriber_name: string;
                            };
                        terms_and_conditions?: null
                        | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      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 | { [key: ...]: ... };
                              role: "manager" | "admin" | "member";
                              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 | { [key: ...]: ... };
                          role: "manager" | "admin" | "member";
                          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]: { expire_time: string; expires_in: number };
                      };
                      subscription_admin_verified_id?: null
                      | string;
                      subscription_id?: null | string;
                      subscription_info?:
                          | null
                          | {
                              connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                              is_baa: boolean;
                              is_high_assurance: boolean;
                              name: string;
                              subscriber_name: string;
                          };
                      terms_and_conditions?: null
                      | string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The updated group.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/v2/groups/{group_id}/children": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: { include?: null | string[] };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            children: {
                                allowed_actions?: | null
                                | {
                                    accept: (...)[];
                                    add: (...)[];
                                    approve: (...)[];
                                    change_role: (...)[];
                                    decline: (...)[];
                                    invite: (...)[];
                                    join: (...)[];
                                    leave: (...)[];
                                    reject: (...)[];
                                    remove: (...)[];
                                    request_join: (...)[];
                                };
                                child_ids?: null
                                | string[];
                                description?: null | string;
                                enforce_session: boolean;
                                group_type: "regular" | "plus";
                                id: string;
                                memberships?:
                                    | null
                                    | {
                                        group_id: ...;
                                        identity_id: ...;
                                        invite_email_address?: ...;
                                        invite_time?: ...;
                                        membership_fields: ...;
                                        role: ...;
                                        source_group_id?: ...;
                                        status: ...;
                                        status_reason?: ...;
                                        updated?: ...;
                                        username: ...;
                                    }[];
                                my_memberships?: | null
                                | {
                                    group_id: ...;
                                    identity_id: ...;
                                    invite_email_address?: ...;
                                    invite_time?: ...;
                                    membership_fields: ...;
                                    role: ...;
                                    source_group_id?: ...;
                                    status: ...;
                                    status_reason?: ...;
                                    updated?: ...;
                                    username: ...;
                                }[];
                                name: string;
                                parent_id: null
                                | string;
                                policies?: {
                                    authentication_assurance_timeout?: (...) | (...) | (...);
                                    group_members_visibility: (...) | (...);
                                    group_visibility: (...) | (...);
                                    is_high_assurance: boolean;
                                    join_requests?: (...) | (...) | (...);
                                    signup_fields: (...)[];
                                };
                                session_limit?: null
                                | number;
                                session_timeouts: {
                                    [key: string]: { expire_time: string; expires_in: number };
                                };
                                subscription_admin_verified_id?: null
                                | string;
                                subscription_id?: null | string;
                                subscription_info?:
                                    | null
                                    | {
                                        connectors: { [key: ...]: ... };
                                        is_baa: boolean;
                                        is_high_assurance: boolean;
                                        name: string;
                                        subscriber_name: string;
                                    };
                                terms_and_conditions?: null
                                | string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: { include?: null | string[] };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          children: {
                              allowed_actions?: | null
                              | {
                                  accept: (...)[];
                                  add: (...)[];
                                  approve: (...)[];
                                  change_role: (...)[];
                                  decline: (...)[];
                                  invite: (...)[];
                                  join: (...)[];
                                  leave: (...)[];
                                  reject: (...)[];
                                  remove: (...)[];
                                  request_join: (...)[];
                              };
                              child_ids?: null
                              | string[];
                              description?: null | string;
                              enforce_session: boolean;
                              group_type: "regular" | "plus";
                              id: string;
                              memberships?:
                                  | null
                                  | {
                                      group_id: ...;
                                      identity_id: ...;
                                      invite_email_address?: ...;
                                      invite_time?: ...;
                                      membership_fields: ...;
                                      role: ...;
                                      source_group_id?: ...;
                                      status: ...;
                                      status_reason?: ...;
                                      updated?: ...;
                                      username: ...;
                                  }[];
                              my_memberships?: | null
                              | {
                                  group_id: ...;
                                  identity_id: ...;
                                  invite_email_address?: ...;
                                  invite_time?: ...;
                                  membership_fields: ...;
                                  role: ...;
                                  source_group_id?: ...;
                                  status: ...;
                                  status_reason?: ...;
                                  updated?: ...;
                                  username: ...;
                              }[];
                              name: string;
                              parent_id: null
                              | string;
                              policies?: {
                                  authentication_assurance_timeout?: (...) | (...) | (...);
                                  group_members_visibility: (...) | (...);
                                  group_visibility: (...) | (...);
                                  is_high_assurance: boolean;
                                  join_requests?: (...) | (...) | (...);
                                  signup_fields: (...)[];
                              };
                              session_limit?: null
                              | number;
                              session_timeouts: {
                                  [key: string]: { expire_time: string; expires_in: number };
                              };
                              subscription_admin_verified_id?: null
                              | string;
                              subscription_id?: null | string;
                              subscription_info?:
                                  | null
                                  | {
                                      connectors: { [key: ...]: ... };
                                      is_baa: boolean;
                                      is_high_assurance: boolean;
                                      name: string;
                                      subscriber_name: string;
                                  };
                              terms_and_conditions?: null
                              | string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Children

      Get the children of the group.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: { include?: null | string[] };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { group_id: string }
        • Optionalquery?: { include?: null | string[] }
          • Optionalinclude?: null | string[]

            Form encoded or comma separated list of additional fields to include (allowed fields are memberships, my_memberships,policies, allowed_actions, and child_ids )

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        children: {
                            allowed_actions?:
                                | null
                                | {
                                    accept: (...)[];
                                    add: (...)[];
                                    approve: (...)[];
                                    change_role: (...)[];
                                    decline: (...)[];
                                    invite: (...)[];
                                    join: (...)[];
                                    leave: (...)[];
                                    reject: (...)[];
                                    remove: (...)[];
                                    request_join: (...)[];
                                };
                            child_ids?: null
                            | string[];
                            description?: null | string;
                            enforce_session: boolean;
                            group_type: "regular" | "plus";
                            id: string;
                            memberships?:
                                | null
                                | {
                                    group_id: ...;
                                    identity_id: ...;
                                    invite_email_address?: ...;
                                    invite_time?: ...;
                                    membership_fields: ...;
                                    role: ...;
                                    source_group_id?: ...;
                                    status: ...;
                                    status_reason?: ...;
                                    updated?: ...;
                                    username: ...;
                                }[];
                            my_memberships?: | null
                            | {
                                group_id: ...;
                                identity_id: ...;
                                invite_email_address?: ...;
                                invite_time?: ...;
                                membership_fields: ...;
                                role: ...;
                                source_group_id?: ...;
                                status: ...;
                                status_reason?: ...;
                                updated?: ...;
                                username: ...;
                            }[];
                            name: string;
                            parent_id: null
                            | string;
                            policies?: {
                                authentication_assurance_timeout?: (...) | (...) | (...);
                                group_members_visibility: (...) | (...);
                                group_visibility: (...) | (...);
                                is_high_assurance: boolean;
                                join_requests?: (...) | (...) | (...);
                                signup_fields: (...)[];
                            };
                            session_limit?: null
                            | number;
                            session_timeouts: {
                                [key: string]: { expire_time: string; expires_in: number };
                            };
                            subscription_admin_verified_id?: null
                            | string;
                            subscription_id?: null | string;
                            subscription_info?:
                                | null
                                | {
                                    connectors: { [key: ...]: ... };
                                    is_baa: boolean;
                                    is_high_assurance: boolean;
                                    name: string;
                                    subscriber_name: string;
                                };
                            terms_and_conditions?: null
                            | string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      children: {
                          allowed_actions?:
                              | null
                              | {
                                  accept: (...)[];
                                  add: (...)[];
                                  approve: (...)[];
                                  change_role: (...)[];
                                  decline: (...)[];
                                  invite: (...)[];
                                  join: (...)[];
                                  leave: (...)[];
                                  reject: (...)[];
                                  remove: (...)[];
                                  request_join: (...)[];
                              };
                          child_ids?: null
                          | string[];
                          description?: null | string;
                          enforce_session: boolean;
                          group_type: "regular" | "plus";
                          id: string;
                          memberships?:
                              | null
                              | {
                                  group_id: ...;
                                  identity_id: ...;
                                  invite_email_address?: ...;
                                  invite_time?: ...;
                                  membership_fields: ...;
                                  role: ...;
                                  source_group_id?: ...;
                                  status: ...;
                                  status_reason?: ...;
                                  updated?: ...;
                                  username: ...;
                              }[];
                          my_memberships?: | null
                          | {
                              group_id: ...;
                              identity_id: ...;
                              invite_email_address?: ...;
                              invite_time?: ...;
                              membership_fields: ...;
                              role: ...;
                              source_group_id?: ...;
                              status: ...;
                              status_reason?: ...;
                              updated?: ...;
                              username: ...;
                          }[];
                          name: string;
                          parent_id: null
                          | string;
                          policies?: {
                              authentication_assurance_timeout?: (...) | (...) | (...);
                              group_members_visibility: (...) | (...);
                              group_visibility: (...) | (...);
                              is_high_assurance: boolean;
                              join_requests?: (...) | (...) | (...);
                              signup_fields: (...)[];
                          };
                          session_limit?: null
                          | number;
                          session_timeouts: {
                              [key: string]: { expire_time: string; expires_in: number };
                          };
                          subscription_admin_verified_id?: null
                          | string;
                          subscription_id?: null | string;
                          subscription_info?:
                              | null
                              | {
                                  connectors: { [key: ...]: ... };
                                  is_baa: boolean;
                                  is_high_assurance: boolean;
                                  name: string;
                                  subscriber_name: string;
                              };
                          terms_and_conditions?: null
                          | string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/groups/{group_id}/membership_fields": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            [key: string]: {
                                address?: null
                                | string;
                                address1?: null | string;
                                address2?: null | string;
                                city?: null | string;
                                country?: null | string;
                                current_project_name?: null | string;
                                department?: null | string;
                                field_of_science?: null | string;
                                first_name?: null | string;
                                institution?: null | string;
                                last_name?: null | string;
                                organization?: null | string;
                                phone?: null | string;
                                state?: null | string;
                                zip?: null | string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        [key: string]: {
                            address?: null
                            | string;
                            address1?: null | string;
                            address2?: null | string;
                            city?: null | string;
                            country?: null | string;
                            current_project_name?: null | string;
                            department?: null | string;
                            field_of_science?: null | string;
                            first_name?: null | string;
                            institution?: null | string;
                            last_name?: null | string;
                            organization?: null | string;
                            phone?: null | string;
                            state?: null | string;
                            zip?: null | string;
                        };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            [key: string]: {
                                address?: null
                                | string;
                                address1?: null | string;
                                address2?: null | string;
                                city?: null | string;
                                country?: null | string;
                                current_project_name?: null | string;
                                department?: null | string;
                                field_of_science?: null | string;
                                first_name?: null | string;
                                institution?: null | string;
                                last_name?: null | string;
                                organization?: null | string;
                                phone?: null | string;
                                state?: null | string;
                                zip?: null | string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          [key: string]: {
                              address?: null
                              | string;
                              address1?: null | string;
                              address2?: null | string;
                              city?: null | string;
                              country?: null | string;
                              current_project_name?: null | string;
                              department?: null | string;
                              field_of_science?: null | string;
                              first_name?: null | string;
                              institution?: null | string;
                              last_name?: null | string;
                              organization?: null | string;
                              phone?: null | string;
                              state?: null | string;
                              zip?: null | string;
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get the membership fields for your identity set.

      This endpoint allows users to get preferences for each of their identities that affect how their identity can be used in groups. Currently, the supported preferences are:

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        [key: string]: {
                            address?: null | string;
                            address1?: null | string;
                            address2?: null | string;
                            city?: null | string;
                            country?: null | string;
                            current_project_name?: null | string;
                            department?: null | string;
                            field_of_science?: null | string;
                            first_name?: null | string;
                            institution?: null | string;
                            last_name?: null | string;
                            organization?: null | string;
                            phone?: null | string;
                            state?: null | string;
                            zip?: null | string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      [key: string]: {
                          address?: null | string;
                          address1?: null | string;
                          address2?: null | string;
                          city?: null | string;
                          country?: null | string;
                          current_project_name?: null | string;
                          department?: null | string;
                          field_of_science?: null | string;
                          first_name?: null | string;
                          institution?: null | string;
                          last_name?: null | string;
                          organization?: null | string;
                          phone?: null | string;
                          state?: null | string;
                          zip?: null | string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          A mapping from identity_id to an object of membership fields.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      [key: string]: {
                          address?: null
                          | string;
                          address1?: null | string;
                          address2?: null | string;
                          city?: null | string;
                          country?: null | string;
                          current_project_name?: null | string;
                          department?: null | string;
                          field_of_science?: null | string;
                          first_name?: null | string;
                          institution?: null | string;
                          last_name?: null | string;
                          organization?: null | string;
                          phone?: null | string;
                          state?: null | string;
                          zip?: null | string;
                      };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          [key: string]: {
                              address?: null
                              | string;
                              address1?: null | string;
                              address2?: null | string;
                              city?: null | string;
                              country?: null | string;
                              current_project_name?: null | string;
                              department?: null | string;
                              field_of_science?: null | string;
                              first_name?: null | string;
                              institution?: null | string;
                              last_name?: null | string;
                              organization?: null | string;
                              phone?: null | string;
                              state?: null | string;
                              zip?: null | string;
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Set the membership fields for your identity set.

      This endpoint allows users to set preferences for each of their identities that affect how their identity can be used in groups. Currently, the supported preferences are:

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    [key: string]: {
                        address?: null | string;
                        address1?: null | string;
                        address2?: null | string;
                        city?: null | string;
                        country?: null | string;
                        current_project_name?: null | string;
                        department?: null | string;
                        field_of_science?: null | string;
                        first_name?: null | string;
                        institution?: null | string;
                        last_name?: null | string;
                        organization?: null | string;
                        phone?: null | string;
                        state?: null | string;
                        zip?: null | string;
                    };
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        [key: string]: {
                            address?: null | string;
                            address1?: null | string;
                            address2?: null | string;
                            city?: null | string;
                            country?: null | string;
                            current_project_name?: null | string;
                            department?: null | string;
                            field_of_science?: null | string;
                            first_name?: null | string;
                            institution?: null | string;
                            last_name?: null | string;
                            organization?: null | string;
                            phone?: null | string;
                            state?: null | string;
                            zip?: null | string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      [key: string]: {
                          address?: null | string;
                          address1?: null | string;
                          address2?: null | string;
                          city?: null | string;
                          country?: null | string;
                          current_project_name?: null | string;
                          department?: null | string;
                          field_of_science?: null | string;
                          first_name?: null | string;
                          institution?: null | string;
                          last_name?: null | string;
                          organization?: null | string;
                          phone?: null | string;
                          state?: null | string;
                          zip?: null | string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          A mapping from identity_id to a list of membership fields.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/v2/groups/{group_id}/policies": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            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"
                            )[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        authentication_assurance_timeout?: null
                        | number;
                        group_members_visibility?: null | "members" | "managers";
                        group_visibility?: null | "authenticated" | "private";
                        is_high_assurance?: null | boolean;
                        join_requests?: null | boolean;
                        signup_fields?:
                            | null
                            | (
                                | "state"
                                | "department"
                                | "institution"
                                | "current_project_name"
                                | "address"
                                | "city"
                                | "country"
                                | "address1"
                                | "address2"
                                | "zip"
                                | "phone"
                                | "field_of_science"
                            )[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            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"
                            )[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          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"
                          )[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get the policies for the group.

      Get the policies for a group.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        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"
                        )[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      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"
                      )[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          The current group policies.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      authentication_assurance_timeout?: null
                      | number;
                      group_members_visibility?: null | "members" | "managers";
                      group_visibility?: null | "authenticated" | "private";
                      is_high_assurance?: null | boolean;
                      join_requests?: null | boolean;
                      signup_fields?:
                          | null
                          | (
                              | "state"
                              | "department"
                              | "institution"
                              | "current_project_name"
                              | "address"
                              | "city"
                              | "country"
                              | "address1"
                              | "address2"
                              | "zip"
                              | "phone"
                              | "field_of_science"
                          )[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          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"
                          )[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Set the policies for the group.

      Update the policies for a group.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    authentication_assurance_timeout?: null | number;
                    group_members_visibility?: null | "members" | "managers";
                    group_visibility?: null | "authenticated" | "private";
                    is_high_assurance?: null | boolean;
                    join_requests?: null | boolean;
                    signup_fields?:
                        | null
                        | (
                            | "state"
                            | "department"
                            | "institution"
                            | "current_project_name"
                            | "address"
                            | "city"
                            | "country"
                            | "address1"
                            | "address2"
                            | "zip"
                            | "phone"
                            | "field_of_science"
                        )[];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        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"
                        )[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      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"
                      )[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          The updated set of policies.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/v2/groups/{group_id}/subscription_admin_verified": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { group_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": { subscription_admin_verified_id: null
                    | string };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            group_id: string;
                            subscription_admin_verified_id: null
                            | string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { group_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": { subscription_admin_verified_id: null
                  | string };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          group_id: string;
                          subscription_admin_verified_id: null
                          | string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Update the subscription_admin_verified_id

      Update the subscription_admin_verified_id on a group.

      If the group already has a subscription_admin_verified_id associated with it, then
the user must be an admin of the subscription group whose subscription_id
corresponds to the old value.

If the user is setting the subscription_admin_verified_id to a non-null value,
then they must be an admin of the subscription group whose subscription_id
corresponds to the new value.

Group admins can clear the value by using the regular groups update endpoint.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { group_id: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": { subscription_admin_verified_id: null | string };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        group_id: string;
                        subscription_admin_verified_id: null | string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      group_id: string;
                      subscription_admin_verified_id: null | string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The updated group.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/v2/groups/my_groups": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { statuses?: string[] };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            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?: (...)
                                    | (...)
                                    | (...);
                                    invite_time?: (...) | (...) | (...);
                                    membership_fields: (...) | (...);
                                    role: (...) | (...) | (...);
                                    source_group_id?: (...) | (...);
                                    status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                    status_reason?: (...) | (...) | (...);
                                    updated?: (...) | (...) | (...);
                                    username: string;
                                }[];
                            my_memberships?: | null
                            | {
                                group_id: string;
                                identity_id: string;
                                invite_email_address?: (...)
                                | (...)
                                | (...);
                                invite_time?: (...) | (...) | (...);
                                membership_fields: (...) | (...);
                                role: (...) | (...) | (...);
                                source_group_id?: (...) | (...);
                                status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                status_reason?: (...) | (...) | (...);
                                updated?: (...) | (...) | (...);
                                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: (
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                )[];
                            };
                            session_limit?: null
                            | number;
                            session_timeouts: {
                                [key: string]: { expire_time: string; expires_in: number };
                            };
                            subscription_admin_verified_id?: null
                            | string;
                            subscription_id?: null | string;
                            subscription_info?:
                                | null
                                | {
                                    connectors: { [key: string]: { is_baa: ...; is_ha: ... } };
                                    is_baa: boolean;
                                    is_high_assurance: boolean;
                                    name: string;
                                    subscriber_name: string;
                                };
                            terms_and_conditions?: null
                            | string;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: { statuses?: string[] };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          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?: (...)
                                  | (...)
                                  | (...);
                                  invite_time?: (...) | (...) | (...);
                                  membership_fields: (...) | (...);
                                  role: (...) | (...) | (...);
                                  source_group_id?: (...) | (...);
                                  status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                  status_reason?: (...) | (...) | (...);
                                  updated?: (...) | (...) | (...);
                                  username: string;
                              }[];
                          my_memberships?: | null
                          | {
                              group_id: string;
                              identity_id: string;
                              invite_email_address?: (...)
                              | (...)
                              | (...);
                              invite_time?: (...) | (...) | (...);
                              membership_fields: (...) | (...);
                              role: (...) | (...) | (...);
                              source_group_id?: (...) | (...);
                              status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                              status_reason?: (...) | (...) | (...);
                              updated?: (...) | (...) | (...);
                              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: (
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                              )[];
                          };
                          session_limit?: null
                          | number;
                          session_timeouts: {
                              [key: string]: { expire_time: string; expires_in: number };
                          };
                          subscription_admin_verified_id?: null
                          | string;
                          subscription_id?: null | string;
                          subscription_info?:
                              | null
                              | {
                                  connectors: { [key: string]: { is_baa: ...; is_ha: ... } };
                                  is_baa: boolean;
                                  is_high_assurance: boolean;
                                  name: string;
                                  subscriber_name: string;
                              };
                          terms_and_conditions?: null
                          | string;
                      }[];
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Retrieve your groups and memberships

      This endpoint returns, as an array, all groups in which the user and its linked identities is an active member, manager, or admin, by default.

      The my_memberships field is included by default.

The optional query parameter, `statuses`, results in the array containing
those memberships with one of the specified status(es). The default value
is `active`.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { statuses?: string[] };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: { statuses?: string[] }
          • Optionalstatuses?: string[]

            Form-encoded or comma-separated list of statuses. Memberships with these statuses will be included in the memberships array. Valid values are active, invited, pending, rejected, removed, left, and declined.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        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?: (...)
                                | (...)
                                | (...);
                                invite_time?: (...) | (...) | (...);
                                membership_fields: (...) | (...);
                                role: (...) | (...) | (...);
                                source_group_id?: (...) | (...);
                                status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                status_reason?: (...) | (...) | (...);
                                updated?: (...) | (...) | (...);
                                username: string;
                            }[];
                        my_memberships?: | null
                        | {
                            group_id: string;
                            identity_id: string;
                            invite_email_address?: (...)
                            | (...)
                            | (...);
                            invite_time?: (...) | (...) | (...);
                            membership_fields: (...) | (...);
                            role: (...) | (...) | (...);
                            source_group_id?: (...) | (...);
                            status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                            status_reason?: (...) | (...) | (...);
                            updated?: (...) | (...) | (...);
                            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: (
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                            )[];
                        };
                        session_limit?: null
                        | number;
                        session_timeouts: {
                            [key: string]: { expire_time: string; expires_in: number };
                        };
                        subscription_admin_verified_id?: null
                        | string;
                        subscription_id?: null | string;
                        subscription_info?:
                            | null
                            | {
                                connectors: { [key: string]: { is_baa: ...; is_ha: ... } };
                                is_baa: boolean;
                                is_high_assurance: boolean;
                                name: string;
                                subscriber_name: string;
                            };
                        terms_and_conditions?: null
                        | string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      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?: (...)
                              | (...)
                              | (...);
                              invite_time?: (...) | (...) | (...);
                              membership_fields: (...) | (...);
                              role: (...) | (...) | (...);
                              source_group_id?: (...) | (...);
                              status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                              status_reason?: (...) | (...) | (...);
                              updated?: (...) | (...) | (...);
                              username: string;
                          }[];
                      my_memberships?: | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: (...)
                          | (...)
                          | (...);
                          invite_time?: (...) | (...) | (...);
                          membership_fields: (...) | (...);
                          role: (...) | (...) | (...);
                          source_group_id?: (...) | (...);
                          status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                          status_reason?: (...) | (...) | (...);
                          updated?: (...) | (...) | (...);
                          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: (
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                          )[];
                      };
                      session_limit?: null
                      | number;
                      session_timeouts: {
                          [key: string]: { expire_time: string; expires_in: number };
                      };
                      subscription_admin_verified_id?: null
                      | string;
                      subscription_id?: null | string;
                      subscription_info?:
                          | null
                          | {
                              connectors: { [key: string]: { is_baa: ...; is_ha: ... } };
                              is_baa: boolean;
                              is_high_assurance: boolean;
                              name: string;
                              subscriber_name: string;
                          };
                      terms_and_conditions?: null
                      | string;
                  }[];
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Unprocessable Entity

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/groups/statuses": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            [key: string]: {
                                active: number;
                                declined: number;
                                invited: number;
                                left: number;
                                pending: number;
                                rejected: number;
                                removed: number;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          [key: string]: {
                              active: number;
                              declined: number;
                              invited: number;
                              left: number;
                              pending: number;
                              rejected: number;
                              removed: number;
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get the status counts of memberships for each group you are an admin or manager of.

      This endpoint retreives all the membership counts for groups where the caller is either an admin or manager.

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        [key: string]: {
                            active: number;
                            declined: number;
                            invited: number;
                            left: number;
                            pending: number;
                            rejected: number;
                            removed: number;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      [key: string]: {
                          active: number;
                          declined: number;
                          invited: number;
                          left: number;
                          pending: number;
                          rejected: number;
                          removed: number;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          A mapping from group_id to an object of status counts for memberships

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/preferences": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { [key: string]: { allow_add: null
                        | boolean } };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": { [key: string]: { allow_add: null
                    | boolean } };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": { [key: string]: { allow_add: null
                        | boolean } };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { [key: string]: { allow_add: null
                      | boolean } };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get the preferences for your identity set.

      This endpoint allows users to get preferences for each of their identities that affect how their identity can be used in groups. Currently, the supported preferences are:

      - **allow_add**: Whether or not an identity can be added
      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { [key: string]: { allow_add: null | boolean } };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { [key: string]: { allow_add: null | boolean } };
              };
              headers: { [name: string]: unknown };
          }

          A mapping from identity_id to a list of preferences.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": { [key: string]: { allow_add: null
                  | boolean } };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": { [key: string]: { allow_add: null
                      | boolean } };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Set the preferences for your identity set.

      This endpoint allows users to set preferences for each of their identities that affect how their identity can be used in groups. Currently, the supported preferences are:

      - **allow_add**: Whether or not an identity can be added
      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": { [key: string]: { allow_add: null | boolean } };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": { [key: string]: { allow_add: null | boolean } };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { [key: string]: { allow_add: null | boolean } };
              };
              headers: { [name: string]: unknown };
          }

          A mapping from identity_id to a list of preferences.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/v2/subscription_info/{subscription_id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { subscription_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            group_id: string;
                            subscription_id: string;
                            subscription_info: {
                                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                                is_baa: boolean;
                                is_high_assurance: boolean;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            authorization_parameters: {
                                extra?: { [key: string]: unknown };
                                required_scopes?: string[];
                                session_message?: string;
                                session_required_identities?: string[];
                                session_required_mfa?: boolean;
                                session_required_policies?: string[];
                                session_required_single_domain?: string[];
                            };
                            code: string;
                            detail: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            detail: string;
                            provided_scopes?: null
                            | string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { code: string; detail: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { subscription_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          group_id: string;
                          subscription_id: string;
                          subscription_info: {
                              connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                              is_baa: boolean;
                              is_high_assurance: boolean;
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          authorization_parameters: {
                              extra?: { [key: string]: unknown };
                              required_scopes?: string[];
                              session_message?: string;
                              session_required_identities?: string[];
                              session_required_mfa?: boolean;
                              session_required_policies?: string[];
                              session_required_single_domain?: string[];
                          };
                          code: string;
                          detail: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          detail: string;
                          provided_scopes?: null
                          | string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { code: string; detail: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get groups by subscription_id

      This endpoint allows users to retrieve limited information about all groups that have the given subscription_id. Currently, the fields returned for each group are:

      - **group_id**: The unique UUID for the group
- **subscription_id**: The unique UUID for the subscription; identical to the id
  provided in the request
- **subscription_info**: Basic information about the subscription; excludes the
  subscription name for privacy purposes
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { subscription_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        group_id: string;
                        subscription_id: string;
                        subscription_info: {
                            connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                            is_baa: boolean;
                            is_high_assurance: boolean;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        authorization_parameters: {
                            extra?: { [key: string]: unknown };
                            required_scopes?: string[];
                            session_message?: string;
                            session_required_identities?: string[];
                            session_required_mfa?: boolean;
                            session_required_policies?: string[];
                            session_required_single_domain?: string[];
                        };
                        code: string;
                        detail: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        detail: string;
                        provided_scopes?: null
                        | string[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { code: string; detail: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      group_id: string;
                      subscription_id: string;
                      subscription_info: {
                          connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                          is_baa: boolean;
                          is_high_assurance: boolean;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          A list of groups with the given subscription_id.

        • 401: {
              content: {
                  "application/json": {
                      authorization_parameters: {
                          extra?: { [key: string]: unknown };
                          required_scopes?: string[];
                          session_message?: string;
                          session_required_identities?: string[];
                          session_required_mfa?: boolean;
                          session_required_policies?: string[];
                          session_required_single_domain?: string[];
                      };
                      code: string;
                      detail: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      detail: string;
                      provided_scopes?: null | string[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

        • 500: {
              content: { "application/json": { code: string; detail: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined

    Settings

    Member Visibility

    On This Page

    Properties