Globus SDK for JavaScript
    Preparing search index...
    interface components {
        headers: never;
        parameters: never;
        pathItems: never;
        requestBodies: never;
        responses: never;
        schemas: {
            AllowedActionsModel: {
                accept: string[];
                add: string[];
                approve: string[];
                change_role: string[];
                decline: string[];
                invite: string[];
                join: string[];
                leave: string[];
                reject: string[];
                remove: string[];
                request_join: string[];
            };
            AuthErrorModel: {
                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;
            };
            AuthParamsModel: {
                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[];
            };
            BadRequestErrorModel: {
                ambiguous_identities: string[];
                code: string;
                detail: string;
            };
            BaseErrorModel: { code: string; detail: string };
            ConnectorSubscriptionInfo: { is_baa: boolean; is_ha: boolean };
            ForbiddenErrorModel: {
                code: string;
                detail: string;
                provided_scopes?: null | string[];
            };
            GroupChildrenReadModel: {
                children: {
                    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: string]: unknown };
                            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: string]: unknown };
                        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;
                }[];
            };
            GroupCreateModel: {
                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;
            };
            GroupMembershipPostAction: {
                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 }[];
            };
            GroupMembershipPostActionErrors: {
                accept?: | null
                | { code: string; detail: string; identity_id: string }[];
                add?: null | { code: string; detail: string; identity_id: string }[];
                approve?: null | { code: string; detail: string; identity_id: string }[];
                change_role?:
                    | null
                    | { code: string; detail: string; identity_id: string }[];
                decline?: null | { code: string; detail: string; identity_id: string }[];
                invite?: null | { code: string; detail: string; identity_id: string }[];
                join?: null | { code: string; detail: string; identity_id: string }[];
                leave?: null | { code: string; detail: string; identity_id: string }[];
                reject?: null | { code: string; detail: string; identity_id: string }[];
                remove?: null | { code: string; detail: string; identity_id: string }[];
                request_join?:
                    | null
                    | { code: string; detail: string; identity_id: string }[];
            };
            GroupMembershipPostActionResponse: {
                accept?: | null
                | {
                    group_id: string;
                    identity_id: string;
                    invite_email_address?: null
                    | string;
                    invite_time?: null | string;
                    membership_fields: null | { [key: string]: unknown };
                    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: string]: unknown };
                    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: string]: unknown };
                    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: string]: unknown };
                    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: string]: unknown };
                    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: string; detail: string; identity_id: string }[];
                    add?: null | { code: string; detail: string; identity_id: string }[];
                    approve?: null | { code: string; detail: string; identity_id: string }[];
                    change_role?:
                        | null
                        | { code: string; detail: string; identity_id: string }[];
                    decline?: null | { code: string; detail: string; identity_id: string }[];
                    invite?: null | { code: string; detail: string; identity_id: string }[];
                    join?: null | { code: string; detail: string; identity_id: string }[];
                    leave?: null | { code: string; detail: string; identity_id: string }[];
                    reject?: null | { code: string; detail: string; identity_id: string }[];
                    remove?: null | { code: string; detail: string; identity_id: string }[];
                    request_join?:
                        | null
                        | { code: string; detail: string; identity_id: string }[];
                };
                invite?: | null
                | {
                    group_id: string;
                    identity_id: string;
                    invite_email_address?: null
                    | string;
                    invite_time?: null | string;
                    membership_fields: null | { [key: string]: unknown };
                    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: string]: unknown };
                    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: string]: unknown };
                    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: string]: unknown };
                    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: string]: unknown };
                    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: string]: unknown };
                    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;
                }[];
            };
            GroupMemberVisibilityPolicyEnum: "members"
            | "managers";
            GroupPolicyReadModel: {
                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"
                )[];
            };
            GroupPolicyWriteModel: {
                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"
                    )[];
            };
            GroupReadModel: {
                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: string]: unknown };
                        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: string]: unknown };
                    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;
            };
            GroupStatusCounts: {
                active: number;
                declined: number;
                invited: number;
                left: number;
                pending: number;
                rejected: number;
                removed: number;
            };
            GroupSubscriptionModel: {
                group_id: string;
                subscription_id: string;
                subscription_info: {
                    connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                    is_baa: boolean;
                    is_high_assurance: boolean;
                };
            };
            GroupTypeEnum: "regular"
            | "plus";
            GroupVisibilityPolicyEnum: "authenticated" | "private";
            GroupWriteModel: {
                description?: null | string;
                name?: null | string;
                subscription_admin_verified_id?: null | string;
                terms_and_conditions?: null | string;
            };
            HTTPValidationError: {
                detail?: { loc: (string | number)[]; msg: string; type: string }[];
            };
            IdentityPreferences: { allow_add: null
            | boolean };
            MembershipActionBaseModel: { identity_id: string };
            MembershipActionInviteModel: {
                identity_id: string;
                invite_email_address?: null | string;
                role: null | "manager" | "admin" | "member";
                status_reason?: null | string;
            };
            MembershipActionStatusAndRoleModel: {
                identity_id: string;
                role: null
                | "manager"
                | "admin"
                | "member";
                status_reason?: null | string;
            };
            MembershipActionStatusModel: {
                identity_id: string;
                status_reason?: null
                | string;
            };
            MembershipError: { code: string; detail: string; identity_id: string };
            MembershipFields: {
                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;
            };
            MembershipReadModel: {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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;
            };
            MembershipsActionChangeRoleModel: {
                identity_id: string;
                role: null
                | "manager"
                | "admin"
                | "member";
            };
            RoleEnum: "manager"
            | "admin"
            | "member";
            SignupFieldsEnum:
                | "state"
                | "department"
                | "institution"
                | "current_project_name"
                | "address"
                | "city"
                | "country"
                | "address1"
                | "address2"
                | "zip"
                | "phone"
                | "field_of_science";
            StatusEnum: | "active"
            | "invited"
            | "pending"
            | "rejected"
            | "removed"
            | "left"
            | "declined";
            SubscriptionModel: {
                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                is_baa: boolean;
                is_high_assurance: boolean;
                name: string;
                subscriber_name: string;
            };
            SubscriptionModelLimited: {
                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                is_baa: boolean;
                is_high_assurance: boolean;
            };
            SubscriptionVerifiedReadModel: {
                group_id: string;
                subscription_admin_verified_id: null
                | string;
            };
            SubscriptionVerifiedWriteModel: {
                subscription_admin_verified_id: null
                | string;
            };
            TimeoutData: { expire_time: string; expires_in: number };
            ValidationError: { loc: (string | number)[]; msg: string; type: string };
        };
    }
    Index

    Properties

    headers: never
    parameters: never
    pathItems: never
    requestBodies: never
    responses: never
    schemas: {
        AllowedActionsModel: {
            accept: string[];
            add: string[];
            approve: string[];
            change_role: string[];
            decline: string[];
            invite: string[];
            join: string[];
            leave: string[];
            reject: string[];
            remove: string[];
            request_join: string[];
        };
        AuthErrorModel: {
            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;
        };
        AuthParamsModel: {
            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[];
        };
        BadRequestErrorModel: {
            ambiguous_identities: string[];
            code: string;
            detail: string;
        };
        BaseErrorModel: { code: string; detail: string };
        ConnectorSubscriptionInfo: { is_baa: boolean; is_ha: boolean };
        ForbiddenErrorModel: {
            code: string;
            detail: string;
            provided_scopes?: null | string[];
        };
        GroupChildrenReadModel: {
            children: {
                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: string]: unknown };
                        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: string]: unknown };
                    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;
            }[];
        };
        GroupCreateModel: {
            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;
        };
        GroupMembershipPostAction: {
            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 }[];
        };
        GroupMembershipPostActionErrors: {
            accept?: null
            | { code: string; detail: string; identity_id: string }[];
            add?: null | { code: string; detail: string; identity_id: string }[];
            approve?: null | { code: string; detail: string; identity_id: string }[];
            change_role?:
                | null
                | { code: string; detail: string; identity_id: string }[];
            decline?: null | { code: string; detail: string; identity_id: string }[];
            invite?: null | { code: string; detail: string; identity_id: string }[];
            join?: null | { code: string; detail: string; identity_id: string }[];
            leave?: null | { code: string; detail: string; identity_id: string }[];
            reject?: null | { code: string; detail: string; identity_id: string }[];
            remove?: null | { code: string; detail: string; identity_id: string }[];
            request_join?:
                | null
                | { code: string; detail: string; identity_id: string }[];
        };
        GroupMembershipPostActionResponse: {
            accept?: | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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: string]: unknown };
                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: string]: unknown };
                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: string]: unknown };
                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: string]: unknown };
                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: string; detail: string; identity_id: string }[];
                add?: null | { code: string; detail: string; identity_id: string }[];
                approve?: null | { code: string; detail: string; identity_id: string }[];
                change_role?:
                    | null
                    | { code: string; detail: string; identity_id: string }[];
                decline?: null | { code: string; detail: string; identity_id: string }[];
                invite?: null | { code: string; detail: string; identity_id: string }[];
                join?: null | { code: string; detail: string; identity_id: string }[];
                leave?: null | { code: string; detail: string; identity_id: string }[];
                reject?: null | { code: string; detail: string; identity_id: string }[];
                remove?: null | { code: string; detail: string; identity_id: string }[];
                request_join?:
                    | null
                    | { code: string; detail: string; identity_id: string }[];
            };
            invite?: | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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: string]: unknown };
                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: string]: unknown };
                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: string]: unknown };
                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: string]: unknown };
                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: string]: unknown };
                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;
            }[];
        };
        GroupMemberVisibilityPolicyEnum: "members"
        | "managers";
        GroupPolicyReadModel: {
            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"
            )[];
        };
        GroupPolicyWriteModel: {
            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"
                )[];
        };
        GroupReadModel: {
            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: string]: unknown };
                    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: string]: unknown };
                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;
        };
        GroupStatusCounts: {
            active: number;
            declined: number;
            invited: number;
            left: number;
            pending: number;
            rejected: number;
            removed: number;
        };
        GroupSubscriptionModel: {
            group_id: string;
            subscription_id: string;
            subscription_info: {
                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                is_baa: boolean;
                is_high_assurance: boolean;
            };
        };
        GroupTypeEnum: "regular"
        | "plus";
        GroupVisibilityPolicyEnum: "authenticated" | "private";
        GroupWriteModel: {
            description?: null | string;
            name?: null | string;
            subscription_admin_verified_id?: null | string;
            terms_and_conditions?: null | string;
        };
        HTTPValidationError: {
            detail?: { loc: (string | number)[]; msg: string; type: string }[];
        };
        IdentityPreferences: { allow_add: null
        | boolean };
        MembershipActionBaseModel: { identity_id: string };
        MembershipActionInviteModel: {
            identity_id: string;
            invite_email_address?: null | string;
            role: null | "manager" | "admin" | "member";
            status_reason?: null | string;
        };
        MembershipActionStatusAndRoleModel: {
            identity_id: string;
            role: null
            | "manager"
            | "admin"
            | "member";
            status_reason?: null | string;
        };
        MembershipActionStatusModel: {
            identity_id: string;
            status_reason?: null
            | string;
        };
        MembershipError: { code: string; detail: string; identity_id: string };
        MembershipFields: {
            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;
        };
        MembershipReadModel: {
            group_id: string;
            identity_id: string;
            invite_email_address?: null
            | string;
            invite_time?: null | string;
            membership_fields: null | { [key: string]: unknown };
            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;
        };
        MembershipsActionChangeRoleModel: {
            identity_id: string;
            role: null
            | "manager"
            | "admin"
            | "member";
        };
        RoleEnum: "manager"
        | "admin"
        | "member";
        SignupFieldsEnum:
            | "state"
            | "department"
            | "institution"
            | "current_project_name"
            | "address"
            | "city"
            | "country"
            | "address1"
            | "address2"
            | "zip"
            | "phone"
            | "field_of_science";
        StatusEnum: | "active"
        | "invited"
        | "pending"
        | "rejected"
        | "removed"
        | "left"
        | "declined";
        SubscriptionModel: {
            connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
            is_baa: boolean;
            is_high_assurance: boolean;
            name: string;
            subscriber_name: string;
        };
        SubscriptionModelLimited: {
            connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
            is_baa: boolean;
            is_high_assurance: boolean;
        };
        SubscriptionVerifiedReadModel: {
            group_id: string;
            subscription_admin_verified_id: null
            | string;
        };
        SubscriptionVerifiedWriteModel: {
            subscription_admin_verified_id: null
            | string;
        };
        TimeoutData: { expire_time: string; expires_in: number };
        ValidationError: { loc: (string | number)[]; msg: string; type: string };
    }

    Type declaration

    • AllowedActionsModel: {
          accept: string[];
          add: string[];
          approve: string[];
          change_role: string[];
          decline: string[];
          invite: string[];
          join: string[];
          leave: string[];
          reject: string[];
          remove: string[];
          request_join: string[];
      }

      AllowedActionsModel

      Specifies which identities associated with the current token, if any, are in principle allowed to perform various actions.

      Attempting to perform an action which no identity has permissions for is a
      transactional error, and the entire request will fail.
      
      • accept: string[]

        Accept

        User's identities which can accept an invitation to the group, pending admin/manager approval.

      • add: string[]

        Add

        User's identities which are allowed to add members to the group.

      • approve: string[]

        Approve

        Identities that are approved to join the group.

      • change_role: string[]

        Change Role

        User's identities which are allowed to change group members' roles.

      • decline: string[]

        Decline

        User's invited identities which can decline an invitation.

      • invite: string[]

        Invite

        User's identities which are allowed to invite members to the group.

      • join: string[]

        Join

        User's identities which can join the group, becoming active members.

      • leave: string[]

        Leave

        User's active identities which can leave the group.

      • reject: string[]

        Reject

        Identities that are rejected from joining the group.

      • remove: string[]

        Remove

        User's identities which are allowed to remove members from the group.

      • request_join: string[]

        Request Join

        User's identities which can request to join the group, pending admin/manager approval.

    • AuthErrorModel: {
          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;
      }

      AuthErrorModel

      • 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[];
        }

        Additional fields in compliance with the Globus Auth Requirements Error format.

        • Optionalextra?: { [key: string]: unknown }

          Extra

          A dictionary of additional fields that were provided.

        • Optionalrequired_scopes?: string[]

          Required Scopes

          A list of scopes for which consent is required.

        • Optionalsession_message?: string

          Session Message

          A message to be displayed to the user.

        • Optionalsession_required_identities?: string[]

          Session Required Identities

          A list of identities required for the session.

        • Optionalsession_required_mfa?: boolean

          Session Required Mfa

          Whether MFA is required for the session.

        • Optionalsession_required_policies?: string[]

          Session Required Policies

          A list of policies required for the session.

        • Optionalsession_required_single_domain?: string[]

          Session Required Single Domain

          A list of domains required for the session.

      • code: string

        Code

        A machine parsable string representing the type of error.

      • detail: string

        Detail

        A human readable explanation of the error.

    • AuthParamsModel: {
          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[];
      }

      AuthParamsModel

      • Optionalextra?: { [key: string]: unknown }

        Extra

        A dictionary of additional fields that were provided.

      • Optionalrequired_scopes?: string[]

        Required Scopes

        A list of scopes for which consent is required.

      • Optionalsession_message?: string

        Session Message

        A message to be displayed to the user.

      • Optionalsession_required_identities?: string[]

        Session Required Identities

        A list of identities required for the session.

      • Optionalsession_required_mfa?: boolean

        Session Required Mfa

        Whether MFA is required for the session.

      • Optionalsession_required_policies?: string[]

        Session Required Policies

        A list of policies required for the session.

      • Optionalsession_required_single_domain?: string[]

        Session Required Single Domain

        A list of domains required for the session.

    • BadRequestErrorModel: { ambiguous_identities: string[]; code: string; detail: string }

      BadRequestErrorModel

      • ambiguous_identities: string[]

        Ambiguous Identities

        List of duplicate identities that caused the exception.

      • code: string

        Code

        A machine parsable string representing the type of error.

      • detail: string

        Detail

        A human readable explanation of the error.

    • BaseErrorModel: { code: string; detail: string }

      BaseErrorModel

      • code: string

        Code

        A machine parsable string representing the type of error.

      • detail: string

        Detail

        A human readable explanation of the error.

    • ConnectorSubscriptionInfo: { is_baa: boolean; is_ha: boolean }

      ConnectorSubscriptionInfo

      • is_baa: boolean

        Is Baa

        True if BAA connector subscription.

      • is_ha: boolean

        Is Ha

        True if HA connector subscription.

    • ForbiddenErrorModel: { code: string; detail: string; provided_scopes?: null | string[] }

      ForbiddenErrorModel

      • code: string

        Code

        A machine parsable string representing the type of error.

      • detail: string

        Detail

        A human readable explanation of the error.

      • Optionalprovided_scopes?: null | string[]

        Provided Scopes

        List of all scopes provided to the user.

    • GroupChildrenReadModel: {
          children: {
              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: string]: unknown };
                      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: string]: unknown };
                  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;
          }[];
      }

      GroupChildrenReadModel

      • children: {
            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: string]: unknown };
                    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: string]: unknown };
                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;
        }[]

        Children

        The children of the group.

    • GroupCreateModel: {
          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;
      }

      GroupCreateModel

      • Optionaldescription?: null | string

        Description

        The description of the group.

      • name: string

        Name

        The name of the group.

      • Optionalparent_id?: null | string

        Parent Id

        The ID of the parent of the group to be created. The identity creating this group must be an admin of the parent group.

      • Optionalpolicies?: {
            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"
                )[];
        }

        Policies for the group regarding members etc.

        • Optionalauthentication_assurance_timeout?: null | number

          Authentication Assurance Timeout

          Maximum allowed seconds before a user must reauthenticate to access the group if is set to High Assurance. Defaults to 28800 for HA groups.

        • Optionalgroup_members_visibility?: null | "members" | "managers"
        • Optionalgroup_visibility?: null | "authenticated" | "private"
        • Optionalis_high_assurance?: null | boolean

          Is High Assurance

        • Optionaljoin_requests?: null | boolean

          Join Requests

          If true then users may request to join the group.

        • Optionalsignup_fields?:
              | null
              | (
                  | "state"
                  | "department"
                  | "institution"
                  | "current_project_name"
                  | "address"
                  | "city"
                  | "country"
                  | "address1"
                  | "address2"
                  | "zip"
                  | "phone"
                  | "field_of_science"
              )[]

          Signup Fields

      • Optionalterms_and_conditions?: null | string

        Terms And Conditions

        The terms and conditions for group membership

    • GroupMembershipPostAction: {
          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 }[];
      }

      GroupMembershipPostAction

      • Optionalaccept?: null | { identity_id: string; status_reason?: null | string }[]

        Accept

        List of identities that have been invited and should be accepted to the group.

      • Optionaladd?:
            | null
            | {
                identity_id: string;
                role: null
                | "manager"
                | "admin"
                | "member";
                status_reason?: null | string;
            }[]

        Add

        List of identities to add as active members of the group

      • Optionalapprove?: null | { identity_id: string; status_reason?: null | string }[]

        Approve

        List of pending identities that will be approved to join the group.

      • Optionalchange_role?: null | { identity_id: string; role: null | "manager" | "admin" | "member" }[]

        Change Role

        List of identities whose roles are to be changed

      • Optionaldecline?: null | { identity_id: string; status_reason?: null | string }[]

        Decline

        List of identities that are declining an invitation to join.

      • Optionalinvite?:
            | null
            | {
                identity_id: string;
                invite_email_address?: null
                | string;
                role: null | "manager" | "admin" | "member";
                status_reason?: null | string;
            }[]

        Invite

        List of identities to invite to the group.

      • Optionaljoin?: null | { identity_id: string }[]

        Join

        List of identities that will join the group if policies allow directly joining. These must be identities in the authenticated user's identity set.

      • Optionalleave?: null | { identity_id: string; status_reason?: null | string }[]

        Leave

        List of user's active memberships to leave the group

      • Optionalreject?: null | { identity_id: string; status_reason?: null | string }[]

        Reject

        List of pending identities that will be rejected from joining the group.

      • Optionalremove?: null | { identity_id: string; status_reason?: null | string }[]

        Remove

        List of identities to remove from the group

      • Optionalrequest_join?: null | { identity_id: string }[]

        Request Join

        List of identities that are requesting to join the group. These must be identities in the authenticated user's identity set.

    • GroupMembershipPostActionErrors: {
          accept?: null | { code: string; detail: string; identity_id: string }[];
          add?: null | { code: string; detail: string; identity_id: string }[];
          approve?: null | { code: string; detail: string; identity_id: string }[];
          change_role?:
              | null
              | { code: string; detail: string; identity_id: string }[];
          decline?: null | { code: string; detail: string; identity_id: string }[];
          invite?: null | { code: string; detail: string; identity_id: string }[];
          join?: null | { code: string; detail: string; identity_id: string }[];
          leave?: null | { code: string; detail: string; identity_id: string }[];
          reject?: null | { code: string; detail: string; identity_id: string }[];
          remove?: null | { code: string; detail: string; identity_id: string }[];
          request_join?:
              | null
              | { code: string; detail: string; identity_id: string }[];
      }

      GroupMembershipPostActionErrors

      • Optionalaccept?: null | { code: string; detail: string; identity_id: string }[]

        Accept

      • Optionaladd?: null | { code: string; detail: string; identity_id: string }[]

        Add

      • Optionalapprove?: null | { code: string; detail: string; identity_id: string }[]

        Approve

      • Optionalchange_role?: null | { code: string; detail: string; identity_id: string }[]

        Change Role

      • Optionaldecline?: null | { code: string; detail: string; identity_id: string }[]

        Decline

      • Optionalinvite?: null | { code: string; detail: string; identity_id: string }[]

        Invite

      • Optionaljoin?: null | { code: string; detail: string; identity_id: string }[]

        Join

      • Optionalleave?: null | { code: string; detail: string; identity_id: string }[]

        Leave

      • Optionalreject?: null | { code: string; detail: string; identity_id: string }[]

        Reject

      • Optionalremove?: null | { code: string; detail: string; identity_id: string }[]

        Remove

      • Optionalrequest_join?: null | { code: string; detail: string; identity_id: string }[]

        Request Join

    • GroupMembershipPostActionResponse: {
          accept?:
              | null
              | {
                  group_id: string;
                  identity_id: string;
                  invite_email_address?: null
                  | string;
                  invite_time?: null | string;
                  membership_fields: null | { [key: string]: unknown };
                  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: string]: unknown };
              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: string]: unknown };
              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: string]: unknown };
              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: string]: unknown };
              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: string; detail: string; identity_id: string }[];
              add?: null | { code: string; detail: string; identity_id: string }[];
              approve?: null | { code: string; detail: string; identity_id: string }[];
              change_role?:
                  | null
                  | { code: string; detail: string; identity_id: string }[];
              decline?: null | { code: string; detail: string; identity_id: string }[];
              invite?: null | { code: string; detail: string; identity_id: string }[];
              join?: null | { code: string; detail: string; identity_id: string }[];
              leave?: null | { code: string; detail: string; identity_id: string }[];
              reject?: null | { code: string; detail: string; identity_id: string }[];
              remove?: null | { code: string; detail: string; identity_id: string }[];
              request_join?:
                  | null
                  | { code: string; detail: string; identity_id: string }[];
          };
          invite?: | null
          | {
              group_id: string;
              identity_id: string;
              invite_email_address?: null
              | string;
              invite_time?: null | string;
              membership_fields: null | { [key: string]: unknown };
              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: string]: unknown };
              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: string]: unknown };
              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: string]: unknown };
              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: string]: unknown };
              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: string]: unknown };
              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;
          }[];
      }

      GroupMembershipPostActionResponse

      • Optionalaccept?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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;
            }[]

        Accept

      • Optionaladd?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionalapprove?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionalchange_role?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionaldecline?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionalerrors?:
            | null
            | {
                accept?: null
                | { code: string; detail: string; identity_id: string }[];
                add?: null | { code: string; detail: string; identity_id: string }[];
                approve?: null | { code: string; detail: string; identity_id: string }[];
                change_role?:
                    | null
                    | { code: string; detail: string; identity_id: string }[];
                decline?: null | { code: string; detail: string; identity_id: string }[];
                invite?: null | { code: string; detail: string; identity_id: string }[];
                join?: null | { code: string; detail: string; identity_id: string }[];
                leave?: null | { code: string; detail: string; identity_id: string }[];
                reject?: null | { code: string; detail: string; identity_id: string }[];
                remove?: null | { code: string; detail: string; identity_id: string }[];
                request_join?:
                    | null
                    | { code: string; detail: string; identity_id: string }[];
            }
      • Optionalinvite?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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;
            }[]

        Invite

      • Optionaljoin?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionalleave?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionalreject?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionalremove?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

      • Optionalrequest_join?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

    • GroupMemberVisibilityPolicyEnum: "members" | "managers"

      GroupMemberVisibilityPolicyEnum

      Who can view group memberships.

      - **members**: All members of the group.
      - **managers**: Only admins and managers.
      
    • GroupPolicyReadModel: {
          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"
          )[];
      }

      GroupPolicyReadModel

      • Optionalauthentication_assurance_timeout?: null | number

        Authentication Assurance Timeout

        Maximum allowed seconds before a user must reauthenticate to access the group if is set to High Assurance. Defaults to 28800 for HA groups.

      • group_members_visibility: "members" | "managers"
      • group_visibility: "authenticated" | "private"
      • is_high_assurance: boolean

        Is High Assurance

      • Optionaljoin_requests?: boolean

        Join Requests

        If true then users may request to join the group.

      • signup_fields: (
            | "state"
            | "department"
            | "institution"
            | "current_project_name"
            | "address"
            | "city"
            | "country"
            | "address1"
            | "address2"
            | "zip"
            | "phone"
            | "field_of_science"
        )[]

        Signup Fields

    • GroupPolicyWriteModel: {
          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"
              )[];
      }

      GroupPolicyWriteModel

      • Optionalauthentication_assurance_timeout?: null | number

        Authentication Assurance Timeout

        Maximum allowed seconds before a user must reauthenticate to access the group if is set to High Assurance. Defaults to 28800 for HA groups.

      • Optionalgroup_members_visibility?: null | "members" | "managers"
      • Optionalgroup_visibility?: null | "authenticated" | "private"
      • Optionalis_high_assurance?: null | boolean

        Is High Assurance

      • Optionaljoin_requests?: null | boolean

        Join Requests

        If true then users may request to join the group.

      • Optionalsignup_fields?:
            | null
            | (
                | "state"
                | "department"
                | "institution"
                | "current_project_name"
                | "address"
                | "city"
                | "country"
                | "address1"
                | "address2"
                | "zip"
                | "phone"
                | "field_of_science"
            )[]

        Signup Fields

    • GroupReadModel: {
          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: string]: unknown };
                  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: string]: unknown };
              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;
      }

      GroupReadModel

      • Optionalallowed_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[];
            }

        The actions allowed for the authenticated user's identities. This is intended to assist clients in determining which actions are possible for a given user.

      • Optionalchild_ids?: null | string[]

        Child Ids

        IDs of the children groups (some of the groups in this list might be private).

      • Optionaldescription?: null | string

        Description

        The description of the group.

      • enforce_session: boolean

        Enforce Session

        false
        
      • group_type: "regular" | "plus"

        The type of group (regular or Globus Plus).

        regular
        
      • id: string

        Id Format: uuid

        The ID of the group.

      • Optionalmemberships?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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;
            }[]

        Memberships

        Optional list of all memberships in the group.

      • Optionalmy_memberships?:
            | null
            | {
                group_id: string;
                identity_id: string;
                invite_email_address?: null
                | string;
                invite_time?: null | string;
                membership_fields: null | { [key: string]: unknown };
                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

        Optional list of memberships the authenticated user has in the group.

      • name: string

        Name

        The name of the group.

      • parent_id: null | string

        Parent Id

        The ID of the parent of the group to be created. The identity creating this group must be an admin of the parent group.

      • Optionalpolicies?: {
            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"
            )[];
        }

        Policies for the group regarding members etc.

        • Optionalauthentication_assurance_timeout?: null | number

          Authentication Assurance Timeout

          Maximum allowed seconds before a user must reauthenticate to access the group if is set to High Assurance. Defaults to 28800 for HA groups.

        • group_members_visibility: "members" | "managers"
        • group_visibility: "authenticated" | "private"
        • is_high_assurance: boolean

          Is High Assurance

        • Optionaljoin_requests?: boolean

          Join Requests

          If true then users may request to join the group.

        • signup_fields: (
              | "state"
              | "department"
              | "institution"
              | "current_project_name"
              | "address"
              | "city"
              | "country"
              | "address1"
              | "address2"
              | "zip"
              | "phone"
              | "field_of_science"
          )[]

          Signup Fields

      • Optionalsession_limit?: null | number

        Session Limit

        Number of seconds required for most recent authentication token

      • session_timeouts: { [key: string]: { expire_time: string; expires_in: number } }

        Session Timeouts

        A mapping of identity_ids to data about when that identity's authentication falls out of this group's session limit. Only identities in the session will be included here.

        {}
        
      • Optionalsubscription_admin_verified_id?: null | string

        Subscription Admin Verified Id

        The ID of the subscription whose admin has verified this resource.

      • Optionalsubscription_id?: null | string

        Subscription Id

        The subscription ID

      • Optionalsubscription_info?:
            | null
            | {
                connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                is_baa: boolean;
                is_high_assurance: boolean;
                name: string;
                subscriber_name: string;
            }

        Detailed information regarding the subscription.

      • Optionalterms_and_conditions?: null | string

        Terms And Conditions

        The terms and conditions for group membership

    • GroupStatusCounts: {
          active: number;
          declined: number;
          invited: number;
          left: number;
          pending: number;
          rejected: number;
          removed: number;
      }

      GroupStatusCounts

      • active: number

        Active

        Count of active group members

        0
        
      • declined: number

        Declined

        Count of declined group members.

        0
        
      • invited: number

        Invited

        Count of identities invited to join the group.

        0
        
      • left: number

        Left

        Count of former group members who left the group.

        0
        
      • pending: number

        Pending

        Count of identities pending acceptance to join the group.

        0
        
      • rejected: number

        Rejected

        Count of indentities that were rejected.

        0
        
      • removed: number

        Removed

        Count of former group members who were removed.

        0
        
    • GroupSubscriptionModel: {
          group_id: string;
          subscription_id: string;
          subscription_info: {
              connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
              is_baa: boolean;
              is_high_assurance: boolean;
          };
      }

      GroupSubscriptionModel

      • group_id: string

        Group Id Format: uuid

        The ID of the group.

      • subscription_id: string

        Subscription Id Format: uuid

        The subscription ID

      • subscription_info: {
            connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
            is_baa: boolean;
            is_high_assurance: boolean;
        }

        Detailed information regarding the subscription.

        • connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } }

          Connectors

          A mapping of connector UUIDs to connector subscription data.

          {}
          
        • is_baa: boolean

          Is Baa

          True if BAA subscriber.

          false
          
        • is_high_assurance: boolean

          Is High Assurance

          True if HA subscriber.

          false
          
    • GroupTypeEnum: "regular" | "plus"

      GroupTypeEnum

    • GroupVisibilityPolicyEnum: "authenticated" | "private"

      GroupVisibilityPolicyEnum

      Who can view the group.

      - **authenticated**: Any authenticated user.
      - **private**: Only active/invited/pending members of the group.
      
    • GroupWriteModel: {
          description?: null | string;
          name?: null | string;
          subscription_admin_verified_id?: null | string;
          terms_and_conditions?: null | string;
      }

      GroupWriteModel

      • Optionaldescription?: null | string

        Description

        The description of the group.

      • Optionalname?: null | string

        Name

        The name of the group.

      • Optionalsubscription_admin_verified_id?: null | string

        Subscription Admin Verified Id

        The ID of the subscription whose admin has verified this resource.

      • Optionalterms_and_conditions?: null | string

        Terms And Conditions

        The terms and conditions for group membership

    • HTTPValidationError: { detail?: { loc: (string | number)[]; msg: string; type: string }[] }

      HTTPValidationError

      • Optionaldetail?: { loc: (string | number)[]; msg: string; type: string }[]

        Detail

    • IdentityPreferences: { allow_add: null | boolean }

      IdentityPreferences

      • allow_add: null | boolean

        Allow Add

        If false, then this identity can not be added directly to a group by an admin.

    • MembershipActionBaseModel: { identity_id: string }

      MembershipActionBaseModel

      • identity_id: string

        Identity Id Format: uuid

        The identity of the user whose membership is being created or updated.

    • MembershipActionInviteModel: {
          identity_id: string;
          invite_email_address?: null | string;
          role: null | "manager" | "admin" | "member";
          status_reason?: null | string;
      }

      MembershipActionInviteModel

      • identity_id: string

        Identity Id Format: uuid

        The identity of the user whose membership is being created or updated.

      • Optionalinvite_email_address?: null | string

        Invite Email Address

        Send the group invitation to the specified email address.

      • role: null | "manager" | "admin" | "member"

        The membership role for the user that is being added, invited, or changed.

        member
        
      • Optionalstatus_reason?: null | string

        Status Reason

        The reason provided when changing the member status.

    • MembershipActionStatusAndRoleModel: {
          identity_id: string;
          role: null | "manager" | "admin" | "member";
          status_reason?: null | string;
      }

      MembershipActionStatusAndRoleModel

      • identity_id: string

        Identity Id Format: uuid

        The identity of the user whose membership is being created or updated.

      • role: null | "manager" | "admin" | "member"

        The membership role for the user that is being added, invited, or changed.

        member
        
      • Optionalstatus_reason?: null | string

        Status Reason

        The reason provided when changing the member status.

    • MembershipActionStatusModel: { identity_id: string; status_reason?: null | string }

      MembershipActionStatusModel

      • identity_id: string

        Identity Id Format: uuid

        The identity of the user whose membership is being created or updated.

      • Optionalstatus_reason?: null | string

        Status Reason

        The reason provided when changing the member status.

    • MembershipError: { code: string; detail: string; identity_id: string }

      MembershipError

      • code: string

        Code

        A machine parsable string representing the type of error.

      • detail: string

        Detail

        A human readable explanation of the error.

      • identity_id: string

        Identity Id

        The identity from the request that caused the error.

    • MembershipFields: {
          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;
      }

      MembershipFields

      • Optionaladdress?: null | string

        Address

      • Optionaladdress1?: null | string

        Address1

      • Optionaladdress2?: null | string

        Address2

      • Optionalcity?: null | string

        City

      • Optionalcountry?: null | string

        Country

      • Optionalcurrent_project_name?: null | string

        Current Project Name

      • Optionaldepartment?: null | string

        Department

      • Optionalfield_of_science?: null | string

        Field Of Science

      • Optionalfirst_name?: null | string

        First Name

      • Optionalinstitution?: null | string

        Institution

      • Optionallast_name?: null | string

        Last Name

      • Optionalorganization?: null | string

        Organization

      • Optionalphone?: null | string

        Phone

      • Optionalstate?: null | string

        State

      • Optionalzip?: null | string

        Zip

    • MembershipReadModel: {
          group_id: string;
          identity_id: string;
          invite_email_address?: null | string;
          invite_time?: null | string;
          membership_fields: null | { [key: string]: unknown };
          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;
      }

      MembershipReadModel

      • group_id: string

        Group Id Format: uuid

        The id of the group the member belongs to.

      • identity_id: string

        Identity Id Format: uuid

        The identity of the user that is a member.

      • Optionalinvite_email_address?: null | string

        Invite Email Address

        Email address for the group invitation.

      • Optionalinvite_time?: null | string

        Invite Time

        RFC 8601 format date and time when the user was invited to the group.

      • membership_fields: null | { [key: string]: unknown }

        Membership Fields

        The additional sign-up fields required by the group.

        {}
        
      • role: "manager" | "admin" | "member"

        The role of the member in the group.

      • Optionalsource_group_id?: string

        Source Group Id Format: uuid

        The subgroup that the identity is a member of causing membership to be implied in this group.

      • status: "active" | "invited" | "pending" | "rejected" | "removed" | "left" | "declined"

        The status of the member in the group.

      • Optionalstatus_reason?: null | string

        Status Reason

        The reason provided when changing the member status.

      • Optionalupdated?: null | string

        Updated

        RFC 8601 format date and time when the membership was last updated.

      • username: string

        Username

        The username of the user that is a member.

    • MembershipsActionChangeRoleModel: { identity_id: string; role: null | "manager" | "admin" | "member" }

      MembershipsActionChangeRoleModel

      • identity_id: string

        Identity Id Format: uuid

        The identity of the user whose membership is being created or updated.

      • role: null | "manager" | "admin" | "member"

        The membership role for the user that is being added, invited, or changed.

        member
        
    • RoleEnum: "manager" | "admin" | "member"

      RoleEnum

    • SignupFieldsEnum:
          | "state"
          | "department"
          | "institution"
          | "current_project_name"
          | "address"
          | "city"
          | "country"
          | "address1"
          | "address2"
          | "zip"
          | "phone"
          | "field_of_science"

      SignupFieldsEnum

      The available signup fields.

    • StatusEnum: "active" | "invited" | "pending" | "rejected" | "removed" | "left" | "declined"

      StatusEnum

    • SubscriptionModel: {
          connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
          is_baa: boolean;
          is_high_assurance: boolean;
          name: string;
          subscriber_name: string;
      }

      SubscriptionModel

      • connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } }

        Connectors

        A mapping of connector UUIDs to connector subscription data.

        {}
        
      • is_baa: boolean

        Is Baa

        True if BAA subscriber.

        false
        
      • is_high_assurance: boolean

        Is High Assurance

        True if HA subscriber.

        false
        
      • name: string

        Name

        The subscription name.

      • subscriber_name: string

        Subscriber Name

        The subscriber's name.

    • SubscriptionModelLimited: {
          connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
          is_baa: boolean;
          is_high_assurance: boolean;
      }

      SubscriptionModelLimited

      • connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } }

        Connectors

        A mapping of connector UUIDs to connector subscription data.

        {}
        
      • is_baa: boolean

        Is Baa

        True if BAA subscriber.

        false
        
      • is_high_assurance: boolean

        Is High Assurance

        True if HA subscriber.

        false
        
    • SubscriptionVerifiedReadModel: { group_id: string; subscription_admin_verified_id: null | string }

      SubscriptionVerifiedReadModel

      • group_id: string

        Group Id Format: uuid

        The ID of the group.

      • subscription_admin_verified_id: null | string

        Subscription Admin Verified Id

        The ID of the subscription whose admin has verified this resource.

    • SubscriptionVerifiedWriteModel: { subscription_admin_verified_id: null | string }

      SubscriptionVerifiedWriteModel

      • subscription_admin_verified_id: null | string

        Subscription Admin Verified Id

        The ID of the subscription whose admin has verified this resource.

    • TimeoutData: { expire_time: string; expires_in: number }

      TimeoutData

      • expire_time: string

        Expire Time Format: date-time

        RFC 8601 format date and time when the identity will have passed the session limit

      • expires_in: number

        Expires In

        Seconds until authentication will have passed the session limit.

    • ValidationError: { loc: (string | number)[]; msg: string; type: string }

      ValidationError

      • loc: (string | number)[]

        Location

      • msg: string

        Message

      • type: string

        Error Type