Globus SDK for JavaScript
    Preparing search index...

    Type Alias EndpointDocument

    https://docs.globus.org/api/transfer/endpoints_and_collections/#endpoint_or_collection_document

    type EndpointDocument = {
        acl_available: boolean;
        acl_editable: boolean;
        acl_max_expiration_period_mins: number | null;
        activated: boolean;
        associated_flow_policy:
            | {
                transfer?: {
                    destination?: { flow?: string
                    | null };
                    source?: { flow?: string | null };
                };
            }
            | null;
        authentication_assurance_timeout: number
        | null;
        authentication_policy_id: string | null;
        authentication_timeout_mins: number | null;
        auto_delete_timeout: number | null;
        canonical_name: string;
        contact_email: string | null;
        contact_info: string | null;
        DATA?: ServerDocument[];
        DATA_TYPE: "endpoint";
        default_directory: string | null;
        department: string | null;
        description: string | null;
        disable_anonymous_writes: boolean;
        disable_verify: boolean;
        display_name: string;
        entity_type: EntityType;
        expire_time: null | string;
        expires_in: -1 | 0 | number;
        force_encryption: boolean;
        force_verify: boolean;
        french_english_bilingual: boolean;
        gcp_connected: boolean | null;
        gcp_paused: boolean | null;
        gcs_manager_url: null | `${string}://${string}`;
        gcs_version: string | null;
        globus_connect_setup_key: string | null;
        guest_collection_activity_notification_policy:
            | GuestCollectionActivityNotificationPolicy
            | null;
        high_assurance: boolean;
        host_endpoint: string
        | null;
        host_endpoint_display_name: string | null;
        host_endpoint_id: string | null;
        host_path: string | null;
        https_server: null | string;
        id: string;
        in_use: boolean;
        info_link: string | null;
        is_globus_connect: boolean;
        keywords: string | null;
        last_accessed_time: string | null;
        local_user_info_available: null | boolean;
        location: string | null;
        mapped_collection_display_name: string | null;
        mapped_collection_id: string | null;
        max_concurrency: null | number;
        max_parallelism: null | number;
        mfa_required: boolean;
        my_effective_roles: (EndpointRole | "restricted_administrator")[];
        myproxy_dn: string | null;
        myproxy_server: string | null;
        name: string;
        network_use: null | "normal" | "minimal" | "aggressive" | "custom";
        non_functional: boolean;
        non_functional_endpoint_display_name: string | null;
        non_functional_endpoint_id: string | null;
        oauth_server: string | null;
        organization: string | null;
        owner_id: string;
        owner_string: string;
        preferred_concurrency: null | number;
        preferred_parallelism: null | number;
        public: boolean;
        requester_pays: boolean;
        restrict_transfers_to_high_assurance: "inbound" | "outbound" | "all" | null;
        s3_owner_activated: false;
        s3_url: null;
        shareable: boolean;
        sharing_target_endpoint: string | null;
        sharing_target_root_path: string | null;
        skip_auto_delete: boolean | null;
        subscription_admin_verified: boolean;
        subscription_id: string | null;
        tlsftp_server: null | string;
        user_message: string | null;
        user_message_link: string | null;
        username: string;
    }
    Index

    Properties

    acl_available acl_editable acl_max_expiration_period_mins activated associated_flow_policy authentication_assurance_timeout authentication_policy_id authentication_timeout_mins auto_delete_timeout canonical_name contact_email contact_info DATA? DATA_TYPE default_directory department description disable_anonymous_writes disable_verify display_name entity_type expire_time expires_in force_encryption force_verify french_english_bilingual gcp_connected gcp_paused gcs_manager_url gcs_version globus_connect_setup_key guest_collection_activity_notification_policy high_assurance host_endpoint host_endpoint_display_name host_endpoint_id host_path https_server id in_use info_link is_globus_connect keywords last_accessed_time local_user_info_available location mapped_collection_display_name mapped_collection_id max_concurrency max_parallelism mfa_required my_effective_roles myproxy_dn myproxy_server name network_use non_functional non_functional_endpoint_display_name non_functional_endpoint_id oauth_server organization owner_id owner_string preferred_concurrency preferred_parallelism public requester_pays restrict_transfers_to_high_assurance s3_owner_activated s3_url shareable sharing_target_endpoint sharing_target_root_path skip_auto_delete subscription_admin_verified subscription_id tlsftp_server user_message user_message_link username

    Properties

    acl_available: boolean

    GCSv4-specific property - no longer supported

    acl_editable: boolean

    use my_effective_roles instead.

    acl_max_expiration_period_mins: number | null
    activated: boolean

    GCSv4-specific property - no longer supported

    associated_flow_policy:
        | {
            transfer?: {
                destination?: { flow?: string
                | null };
                source?: { flow?: string | null };
            };
        }
        | null
    authentication_assurance_timeout: number | null

    use high_assurance and authentication_timeout_mins instead.

    authentication_policy_id: string | null
    authentication_timeout_mins: number | null
    auto_delete_timeout: number | null

    The number of days the endpoint has been configured to be auto-deleted after. NOT the number of days until deletion (must be calculated).

    • Set on Mapped Collections
    • Readable on Mapped and Guest Collections (inherited from Mapped Collection)
    2
    canonical_name: string

    use id instead in API requests, and use display_name to display to users.

    contact_email: string | null
    contact_info: string | null
    DATA?: ServerDocument[]
    DATA_TYPE: "endpoint"
    default_directory: string | null
    department: string | null
    description: string | null
    disable_anonymous_writes: boolean
    disable_verify: boolean
    display_name: string
    entity_type: EntityType
    expire_time: null | string

    GCSv4-specific property - no longer supported

    expires_in: -1 | 0 | number

    GCSv4-specific property - no longer supported

    force_encryption: boolean
    force_verify: boolean
    french_english_bilingual: boolean
    gcp_connected: boolean | null
    gcp_paused: boolean | null
    gcs_manager_url: null | `${string}://${string}`
    gcs_version: string | null
    globus_connect_setup_key: string | null
    guest_collection_activity_notification_policy:
        | GuestCollectionActivityNotificationPolicy
        | null
    high_assurance: boolean
    host_endpoint: string | null

    use host_endpoint_id and host_endpoint_display_name

    host_endpoint_display_name: string | null
    host_endpoint_id: string | null

    UUID of standard endpoint hosting the shared endpoint; null for non-shared endpoints.

    host_path: string | null
    https_server: null | string
    id: string
    in_use: boolean
    info_link: string | null
    is_globus_connect: boolean

    true if the endpoint was created for Globus Connect Personal, false otherwise.

    use entity_type instead.

    keywords: string | null
    last_accessed_time: string | null
    2025-03-06T00:00:00+00:00
    local_user_info_available: null | boolean

    GCSv4-specific property - no longer supported

    location: string | null
    mapped_collection_display_name: string | null
    mapped_collection_id: string | null
    max_concurrency: null | number
    max_parallelism: null | number
    mfa_required: boolean
    my_effective_roles: (EndpointRole | "restricted_administrator")[]
    myproxy_dn: string | null

    GCSv4-specific property - no longer supported

    myproxy_server: string | null

    GCSv4-specific property - no longer supported

    name: string
    network_use: null | "normal" | "minimal" | "aggressive" | "custom"
    non_functional: boolean
    non_functional_endpoint_display_name: string | null
    non_functional_endpoint_id: string | null
    oauth_server: string | null

    GCSv4-specific property - no longer supported

    organization: string | null
    owner_id: string
    owner_string: string
    preferred_concurrency: null | number
    preferred_parallelism: null | number
    public: boolean
    requester_pays: boolean
    restrict_transfers_to_high_assurance: "inbound" | "outbound" | "all" | null
    s3_owner_activated: false
    s3_url: null
    shareable: boolean

    use entity_type instead.

    sharing_target_endpoint: string | null

    use host_endpoint_id instead.

    sharing_target_root_path: string | null

    use host_path instead.

    skip_auto_delete: boolean | null

    Whether or not this endpoint will be skipped during auto-deletion. If this is specified, auto_delete_timeout should be ignored.

    • Only set on Guest Collections
    subscription_admin_verified: boolean
    subscription_id: string | null
    tlsftp_server: null | string
    user_message: string | null
    user_message_link: string | null
    username: string

    use owner_id or owner_string instead.

    Settings

    Member Visibility

    On This Page

    Properties
    acl_availableacl_editableacl_max_expiration_period_minsactivatedassociated_flow_policyauthentication_assurance_timeoutauthentication_policy_idauthentication_timeout_minsauto_delete_timeoutcanonical_namecontact_emailcontact_infoDATADATA_TYPEdefault_directorydepartmentdescriptiondisable_anonymous_writesdisable_verifydisplay_nameentity_typeexpire_timeexpires_inforce_encryptionforce_verifyfrench_english_bilingualgcp_connectedgcp_pausedgcs_manager_urlgcs_versionglobus_connect_setup_keyguest_collection_activity_notification_policyhigh_assurancehost_endpointhost_endpoint_display_namehost_endpoint_idhost_pathhttps_serveridin_useinfo_linkis_globus_connectkeywordslast_accessed_timelocal_user_info_availablelocationmapped_collection_display_namemapped_collection_idmax_concurrencymax_parallelismmfa_requiredmy_effective_rolesmyproxy_dnmyproxy_servernamenetwork_usenon_functionalnon_functional_endpoint_display_namenon_functional_endpoint_idoauth_serverorganizationowner_idowner_stringpreferred_concurrencypreferred_parallelismpublicrequester_paysrestrict_transfers_to_high_assurances3_owner_activateds3_urlshareablesharing_target_endpointsharing_target_root_pathskip_auto_deletesubscription_admin_verifiedsubscription_idtlsftp_serveruser_messageuser_message_linkusername