Globus SDK for JavaScript
    Preparing search index...
    interface components {
        headers: never;
        parameters: {
            collection_id_query_parameter: string;
            marker_query_parameter: string;
            page_size_query_parameter: number;
        };
        pathItems: never;
        requestBodies: never;
        responses: {
            BadRequestError: {
                content: {
                    "application/json": {
                        code?: "bad_request";
                        http_response_code?: 400;
                    } & (
                        | {
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.0.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                        | {
                            authorization_parameters?: null
                            | { [key: string]: unknown };
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.1.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                    );
                };
                headers: { [name: string]: unknown };
            };
            NotFound: {
                content: {
                    "application/json": { code?: "not_found"; http_response_code?: 404 } & (
                        | {
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.0.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                        | {
                            authorization_parameters?: null
                            | { [key: string]: unknown };
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.1.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                    );
                };
                headers: { [name: string]: unknown };
            };
            Unauthorized: {
                content: {
                    "application/json": {
                        code?: "not_authorized";
                        detail?: | string
                        | {
                            DATA_TYPE: "missing_required_scopes#1.0.0";
                            required_scopes?: string[];
                        };
                        http_response_code?: 401;
                    } & (
                        | {
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.0.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                        | {
                            authorization_parameters?: null
                            | { [key: string]: unknown };
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.1.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                    );
                };
                headers: { [name: string]: unknown };
            };
            UnsupportedMediaError: {
                content: {
                    "application/json": {
                        code?: "unsupported_media_type";
                        http_response_code?: 415;
                    } & (
                        | {
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.0.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                        | {
                            authorization_parameters?: null
                            | { [key: string]: unknown };
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.1.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                    );
                };
                headers: { [name: string]: unknown };
            };
            ValidationError: {
                content: {
                    "application/json": {
                        code?: "unprocessable_entity";
                        detail?: | string
                        | {
                            DATA_TYPE: "invalid_input#1.0.0";
                            errors?: { message: string; property?: (...)
                            | (...) }[];
                        };
                        http_response_code?: 422;
                    } & (
                        | {
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.0.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                        | {
                            authorization_parameters?: null
                            | { [key: string]: unknown };
                            code: string;
                            data?: Record<string, unknown>[];
                            DATA_TYPE: "result#1.1.0";
                            detail?: unknown;
                            has_next_page: boolean;
                            http_response_code: number;
                            marker?: null | string;
                            message?: string;
                        }
                    );
                };
                headers: { [name: string]: unknown };
            };
        };
        schemas: {
            Account: {
                DATA_TYPE: "account#1.0.0";
                identity_id?: string;
                storage_gateway_id?: string;
                username?: string;
            };
            Account_1_0_0: {
                DATA_TYPE: "account#1.0.0";
                identity_id?: string;
                storage_gateway_id?: string;
                username?: string;
            };
            ActiveScaleCollectionPolicies: {
                DATA_TYPE: "s3_collection_policies#1.0.0";
            };
            ActiveScaleStoragePolicies: {
                DATA_TYPE: "s3_storage_policies#1.0.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_user_credential_required?: boolean;
            };
            ActiveScaleUserCredentialPolicies: {
                DATA_TYPE: "s3_user_credential_policies#1.0.0";
                s3_key_id?: null
                | string;
                s3_secret_key?: null | string;
            };
            ActivityNotificationPolicy: { status: string[]; transfer_use: string[] };
            AuthenticationTimeout:
                | {
                    DATA_TYPE: "authentication_timeout#1.0.0";
                    high_assurance?: boolean;
                    identities?: string[];
                }
                | {
                    DATA_TYPE: "authentication_timeout#1.1.0";
                    high_assurance?: boolean;
                    identities?: string[];
                    require_mfa?: boolean;
                };
            AuthenticationTimeout_1_0_0: {
                DATA_TYPE: "authentication_timeout#1.0.0";
                high_assurance?: boolean;
                identities?: string[];
            };
            AuthenticationTimeout_1_1_0: {
                DATA_TYPE: "authentication_timeout#1.1.0";
                high_assurance?: boolean;
                identities?: string[];
                require_mfa?: boolean;
            };
            AzureBlobCollectionPolicies: {
                DATA_TYPE: "azure_blob_collection_policies#1.0.0";
            };
            AzureBlobCollectionPolicies_1_0_0: {
                DATA_TYPE: "azure_blob_collection_policies#1.0.0";
            };
            AzureBlobStoragePolicies: | {
                account: null
                | string;
                adls: null | boolean;
                auth_callback?: string;
                auth_type: null | string;
                client_id: null | string;
                DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                secret: null | string;
                tenant: null | string;
                user_credential_required?: boolean;
            }
            | {
                account: null
                | string;
                adls: null | boolean;
                allow_any_account?: boolean;
                auth_callback?: string;
                auth_type: null | string;
                client_id: null | string;
                DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                secret: null | string;
                tenant: null | string;
                user_credential_required?: boolean;
            };
            AzureBlobStoragePolicies_1_0_0: {
                account: null
                | string;
                adls: null | boolean;
                auth_callback?: string;
                auth_type: null | string;
                client_id: null | string;
                DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                secret: null | string;
                tenant: null | string;
                user_credential_required?: boolean;
            };
            AzureBlobStoragePolicies_1_1_0: {
                account: null
                | string;
                adls: null | boolean;
                allow_any_account?: boolean;
                auth_callback?: string;
                auth_type: null | string;
                client_id: null | string;
                DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                secret: null | string;
                tenant: null | string;
                user_credential_required?: boolean;
            };
            AzureBlobUserCredentialPolicies: {
                access_token?: null
                | string;
                DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                tid?: string;
                token_expiry?: string;
            };
            AzureBlobUserCredentialPolicies_1_0_0: {
                access_token?: null
                | string;
                DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                tid?: string;
                token_expiry?: string;
            };
            Batch: { DATA_TYPE: "batch#1.0.0"; ids?: string[] };
            Batch_1_0_0: { DATA_TYPE: "batch#1.0.0"; ids?: string[] };
            BlackPearlCollectionPolicies: {
                DATA_TYPE: "blackpearl_collection_policies#1.0.0";
            };
            BlackPearlCollectionPolicies_1_0_0: {
                DATA_TYPE: "blackpearl_collection_policies#1.0.0";
            };
            BlackPearlStoragePolicies: {
                bp_access_id_file?: string;
                DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                s3_endpoint?: string;
            };
            BlackPearlStoragePolicies_1_0_0: {
                bp_access_id_file?: string;
                DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                s3_endpoint?: string;
            };
            BlackPearlUserCredentialPolicies: {
                access_id?: string;
                DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                secret_key?: string;
            };
            BlackPearlUserCredentialPolicies_1_0_0: {
                access_id?: string;
                DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                secret_key?: string;
            };
            BoxAppAuth: {
                passphrase: string;
                privateKey: string;
                publicKeyID: string;
            };
            BoxAppSettings: {
                appAuth: {
                    passphrase: string;
                    privateKey: string;
                    publicKeyID: string;
                };
                clientID: string;
                clientSecret: string;
            };
            BoxCollectionPolicies: { DATA_TYPE: "box_collection_policies#1.0.0" };
            BoxCollectionPolicies_1_0_0: {
                DATA_TYPE: "box_collection_policies#1.0.0";
            };
            BoxStorage_1_0_0: {
                boxAppSettings: {
                    appAuth: {
                        passphrase: string;
                        privateKey: string;
                        publicKeyID: string;
                    };
                    clientID: string;
                    clientSecret: string;
                };
                DATA_TYPE: "box_storage_policies#1.0.0";
                enterpriseID: string;
            };
            BoxStorage_1_1_0: {
                auth_callback?: string;
                boxAppSettings?: {
                    appAuth: {
                        passphrase: string;
                        privateKey: string;
                        publicKeyID: string;
                    };
                    clientID: string;
                    clientSecret: string;
                };
                client_id?: string;
                DATA_TYPE: "box_storage_policies#1.1.0";
                enterpriseID?: string;
                secret?: string;
                user_api_rate_limit?: number;
                user_credential_required?: boolean;
            };
            BoxStorage_1_2_0: {
                allow_any_account?: boolean;
                auth_callback?: string;
                boxAppSettings?: {
                    appAuth: {
                        passphrase: string;
                        privateKey: string;
                        publicKeyID: string;
                    };
                    clientID: string;
                    clientSecret: string;
                };
                client_id?: string;
                DATA_TYPE: "box_storage_policies#1.2.0";
                enterpriseID?: string;
                secret?: string;
                user_api_rate_limit?: number;
                user_credential_required?: boolean;
            };
            BoxStoragePolicies: | {
                boxAppSettings: {
                    appAuth: {
                        passphrase: string;
                        privateKey: string;
                        publicKeyID: string;
                    };
                    clientID: string;
                    clientSecret: string;
                };
                DATA_TYPE: "box_storage_policies#1.0.0";
                enterpriseID: string;
            }
            | {
                auth_callback?: string;
                boxAppSettings?: {
                    appAuth: {
                        passphrase: string;
                        privateKey: string;
                        publicKeyID: string;
                    };
                    clientID: string;
                    clientSecret: string;
                };
                client_id?: string;
                DATA_TYPE: "box_storage_policies#1.1.0";
                enterpriseID?: string;
                secret?: string;
                user_api_rate_limit?: number;
                user_credential_required?: boolean;
            }
            | {
                allow_any_account?: boolean;
                auth_callback?: string;
                boxAppSettings?: {
                    appAuth: {
                        passphrase: string;
                        privateKey: string;
                        publicKeyID: string;
                    };
                    clientID: string;
                    clientSecret: string;
                };
                client_id?: string;
                DATA_TYPE: "box_storage_policies#1.2.0";
                enterpriseID?: string;
                secret?: string;
                user_api_rate_limit?: number;
                user_credential_required?: boolean;
            };
            BoxUserCredential_1_0_0: {
                DATA_TYPE: "box_user_credential_policies#1.0.0";
            };
            BoxUserCredential_1_1_0: {
                access_token?: null
                | string;
                DATA_TYPE: "box_user_credential_policies#1.1.0";
                email?: null | string;
                max_upload?: number;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                token_expiry?: string;
            };
            BoxUserCredentialPolicies: | {
                DATA_TYPE: "box_user_credential_policies#1.0.0";
            }
            | {
                access_token?: null
                | string;
                DATA_TYPE: "box_user_credential_policies#1.1.0";
                email?: null | string;
                max_upload?: number;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                token_expiry?: string;
            };
            CephCollectionPolicies: { DATA_TYPE: "ceph_collection_policies#1.0.0" };
            CephCollectionPolicies_1_0_0: {
                DATA_TYPE: "ceph_collection_policies#1.0.0";
            };
            CephStoragePolicies: {
                ceph_admin_key_id?: string;
                ceph_admin_secret_key?: string;
                DATA_TYPE: "ceph_storage_policies#1.0.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
            };
            CephStoragePolicies_1_0_0: {
                ceph_admin_key_id?: string;
                ceph_admin_secret_key?: string;
                DATA_TYPE: "ceph_storage_policies#1.0.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
            };
            CephUserCredentialPolicies: {
                DATA_TYPE: "ceph_user_credential_policies#1.0.0";
            };
            CephUserCredentialPolicies_1_0_0: {
                DATA_TYPE: "ceph_user_credential_policies#1.0.0";
            };
            CheckResult: {
                DATA_TYPE: "check_result#1.0.0";
                error?: null
                | Record<string, unknown>;
                id?: string;
                message?: string;
            };
            CheckResult_1_0_0: {
                DATA_TYPE: "check_result#1.0.0";
                error?: null
                | Record<string, unknown>;
                id?: string;
                message?: string;
            };
            Collection: | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.0.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain_name?: string;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.1.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null
                | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.2.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.3.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null
                | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.4.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null
                | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.5.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null
                | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.6.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.7.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.8.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.9.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.10.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.11.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.12.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                auto_delete_timeout?: null | number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.13.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                skip_auto_delete?: boolean;
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                acl_expiration_mins?: null
                | number;
                activity_notification_policy?: {
                    status: string[];
                    transfer_use: string[];
                };
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                auto_delete_timeout?: null
                | number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.14.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                skip_auto_delete?: boolean;
                storage_gateway_id?: string;
                subscription_admin_verified?: boolean;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            }
            | {
                acl_expiration_mins?: null
                | number;
                activity_notification_policy?: {
                    status: string[];
                    transfer_use: string[];
                };
                allow_guest_collections?: boolean;
                associated_flow_policy?: unknown;
                authentication_timeout_mins?: number;
                auto_delete_timeout?: null
                | number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.15.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                skip_auto_delete?: boolean;
                storage_gateway_id?: string;
                subscription_admin_verified?: boolean;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_0_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.0.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain_name?: string;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
            };
            Collection_1_1_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.1.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null
                | string;
                user_message_link?: null | string;
            };
            Collection_1_10_0: {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.10.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_11_0: {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.11.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_12_0: {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.12.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_13_0: {
                acl_expiration_mins?: null
                | number;
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                auto_delete_timeout?: null | number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.13.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                skip_auto_delete?: boolean;
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_14_0: {
                acl_expiration_mins?: null
                | number;
                activity_notification_policy?: {
                    status: string[];
                    transfer_use: string[];
                };
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                auto_delete_timeout?: null
                | number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.14.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                skip_auto_delete?: boolean;
                storage_gateway_id?: string;
                subscription_admin_verified?: boolean;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_15_0: {
                acl_expiration_mins?: null
                | number;
                activity_notification_policy?: {
                    status: string[];
                    transfer_use: string[];
                };
                allow_guest_collections?: boolean;
                associated_flow_policy?: unknown;
                authentication_timeout_mins?: number;
                auto_delete_timeout?: null
                | number;
                collection_base_path: string;
                collection_type: "mapped" | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.15.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                restrict_transfers_to_high_assurance?: | null
                | "inbound"
                | "outbound"
                | "all";
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                skip_auto_delete?: boolean;
                storage_gateway_id?: string;
                subscription_admin_verified?: boolean;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_2_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.2.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_3_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.3.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null
                | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_4_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.4.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null
                | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_5_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.5.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null
                | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_6_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.6.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_7_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.7.0";
                default_directory?: string;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_8_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                DATA_TYPE: "collection#1.8.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            Collection_1_9_0: {
                allow_guest_collections?: boolean;
                authentication_timeout_mins?: number;
                collection_base_path: string;
                collection_type: "mapped"
                | "guest";
                connector_id?: string;
                contact_email?: null | string;
                contact_info?: null | string;
                created_at?: null | string;
                DATA_TYPE: "collection#1.9.0";
                default_directory?: string;
                delete_protected?: boolean;
                deleted?: boolean;
                department?: null | string;
                description?: null | string;
                disable_anonymous_writes?: boolean;
                disable_verify?: boolean;
                display_name: string;
                domain?: {
                    certificate?: null | string;
                    certificate_chain?: null | string;
                    certificate_chain_path?: null | string;
                    certificate_path?: null | string;
                    DATA_TYPE: "domain#1.0.0";
                    domain_name: string;
                    private_key?: null | string;
                    private_key_path?: null | string;
                    wildcard: boolean;
                };
                domain_name?: string;
                enable_https?: boolean;
                force_encryption?: boolean;
                force_verify?: boolean;
                guest_auth_policy_id?: null
                | string;
                high_assurance?: boolean;
                https_url?: string;
                id?: string;
                identity_id?: string;
                info_link?: null | string;
                keywords?: string[];
                last_access?: null | string;
                manager_url?: string;
                mapped_collection_id?: string;
                organization?: string;
                policies?:
                    | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                    | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                    | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                    | { DATA_TYPE: "box_collection_policies#1.0.0" }
                    | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                    | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                        project?: string;
                    }
                    | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                    | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                    | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                    | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                    | {
                        DATA_TYPE: "posix_collection_policies#1.1.0";
                        sharing_groups_allow?: null | string[];
                        sharing_groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                        sharing_groups_allow?: null
                        | string[];
                        sharing_groups_deny?: null | string[];
                    };
                public: boolean;
                require_mfa?: boolean;
                root_path?: string;
                sharing_restrict_paths?: unknown;
                sharing_users_allow?: null
                | string[];
                sharing_users_deny?: null | string[];
                storage_gateway_id?: string;
                tlsftp_url?: string;
                user_credential_id?: string;
                user_message?: null | string;
                user_message_link?: null | string;
            };
            CollectionNotFound: {
                collection_id?: string;
                DATA_TYPE: "collection_not_found#1.0.0";
            };
            CollectionNotFound_1_0_0: {
                collection_id?: string;
                DATA_TYPE: "collection_not_found#1.0.0";
            };
            CollectionOwner: {
                DATA_TYPE: "collection_owner#1.0.0";
                identity_id: string;
            };
            CollectionOwner_1_0_0: {
                DATA_TYPE: "collection_owner#1.0.0";
                identity_id: string;
            };
            Connector: | {
                DATA_TYPE: "connector#1.0.0";
                display_name: string;
                id: string;
                version?: string;
            }
            | {
                DATA_TYPE: "connector#1.1.0";
                display_name: string;
                id: string;
                is_baa?: boolean;
                is_ha?: boolean;
                version?: string;
            };
            Connector_1_0_0: {
                DATA_TYPE: "connector#1.0.0";
                display_name: string;
                id: string;
                version?: string;
            };
            Connector_1_1_0: {
                DATA_TYPE: "connector#1.1.0";
                display_name: string;
                id: string;
                is_baa?: boolean;
                is_ha?: boolean;
                version?: string;
            };
            CredentialNotFound: {
                accounts: {
                    DATA_TYPE: "account#1.0.0";
                    identity_id?: string;
                    storage_gateway_id?: string;
                    username?: string;
                }[];
                DATA_TYPE: "credential_not_found#1.0.0";
            };
            CredentialNotFound_1_0_0: {
                accounts: {
                    DATA_TYPE: "account#1.0.0";
                    identity_id?: string;
                    storage_gateway_id?: string;
                    username?: string;
                }[];
                DATA_TYPE: "credential_not_found#1.0.0";
            };
            Domain: {
                certificate?: null
                | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            Domain_1_0_0: {
                certificate?: null
                | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            DropboxCollectionPolicies: {
                DATA_TYPE: "dropbox_collection_policies#1.0.0";
            };
            DropboxCollectionPolicies_1_0_0: {
                DATA_TYPE: "dropbox_collection_policies#1.0.0";
            };
            DropboxStoragePolicies: {
                allow_any_account?: boolean;
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "dropbox_storage_policies#1.0.0";
                secret: null | string;
                user_api_rate_limit?: number;
            };
            DropboxStoragePolicies_1_0_0: {
                allow_any_account?: boolean;
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "dropbox_storage_policies#1.0.0";
                secret: null | string;
                user_api_rate_limit?: number;
            };
            DropboxUserCredentialPolicies: {
                access_token?: null
                | string;
                DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                root_info?: Record<string, unknown>;
                scopes?: string[];
                sub?: null | string;
                token_expiry?: string;
            };
            DropboxUserCredentialPolicies_1_0_0: {
                access_token?: null
                | string;
                DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                root_info?: Record<string, unknown>;
                scopes?: string[];
                sub?: null | string;
                token_expiry?: string;
            };
            Endpoint: | {
                allow_udt?: boolean;
                contact_email?: string;
                contact_info?: string;
                DATA_TYPE: "endpoint#1.0.0";
                department?: string;
                description?: string;
                display_name: string;
                gcs_manager_url?: string;
                id?: string;
                info_link?: string;
                keywords?: string[];
                max_concurrency?: number;
                max_parallelism?: number;
                network_use: "normal"
                | "minimal"
                | "aggressive"
                | "custom";
                organization?: string;
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                public: boolean;
                subscription_id?: null | string;
            }
            | {
                allow_udt?: boolean;
                contact_email?: string;
                contact_info?: string;
                DATA_TYPE: "endpoint#1.1.0";
                department?: string;
                description?: string;
                display_name: string;
                gcs_manager_url?: string;
                gridftp_control_channel_port?: null
                | number;
                id?: string;
                info_link?: string;
                keywords?: string[];
                max_concurrency?: number;
                max_parallelism?: number;
                network_use: "normal" | "minimal" | "aggressive" | "custom";
                organization?: string;
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                public: boolean;
                subscription_id?: null | string;
            }
            | {
                allow_udt?: boolean;
                contact_email?: string;
                contact_info?: string;
                DATA_TYPE: "endpoint#1.2.0";
                department?: string;
                description?: string;
                display_name: string;
                earliest_last_access?: string;
                gcs_manager_url?: string;
                gridftp_control_channel_port?: null
                | number;
                id?: string;
                info_link?: string;
                keywords?: string[];
                max_concurrency?: number;
                max_parallelism?: number;
                network_use: "normal" | "minimal" | "aggressive" | "custom";
                organization?: string;
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                public: boolean;
                subscription_id?: null | string;
            };
            Endpoint_1_0_0: {
                allow_udt?: boolean;
                contact_email?: string;
                contact_info?: string;
                DATA_TYPE: "endpoint#1.0.0";
                department?: string;
                description?: string;
                display_name: string;
                gcs_manager_url?: string;
                id?: string;
                info_link?: string;
                keywords?: string[];
                max_concurrency?: number;
                max_parallelism?: number;
                network_use: "normal"
                | "minimal"
                | "aggressive"
                | "custom";
                organization?: string;
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                public: boolean;
                subscription_id?: null | string;
            };
            Endpoint_1_1_0: {
                allow_udt?: boolean;
                contact_email?: string;
                contact_info?: string;
                DATA_TYPE: "endpoint#1.1.0";
                department?: string;
                description?: string;
                display_name: string;
                gcs_manager_url?: string;
                gridftp_control_channel_port?: null
                | number;
                id?: string;
                info_link?: string;
                keywords?: string[];
                max_concurrency?: number;
                max_parallelism?: number;
                network_use: "normal" | "minimal" | "aggressive" | "custom";
                organization?: string;
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                public: boolean;
                subscription_id?: null | string;
            };
            Endpoint_1_2_0: {
                allow_udt?: boolean;
                contact_email?: string;
                contact_info?: string;
                DATA_TYPE: "endpoint#1.2.0";
                department?: string;
                description?: string;
                display_name: string;
                earliest_last_access?: string;
                gcs_manager_url?: string;
                gridftp_control_channel_port?: null
                | number;
                id?: string;
                info_link?: string;
                keywords?: string[];
                max_concurrency?: number;
                max_parallelism?: number;
                network_use: "normal" | "minimal" | "aggressive" | "custom";
                organization?: string;
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                public: boolean;
                subscription_id?: null | string;
            };
            EndpointOwner: { DATA_TYPE: "endpoint_owner#1.0.0"; identity_id: string };
            EndpointOwner_1_0_0: {
                DATA_TYPE: "endpoint_owner#1.0.0";
                identity_id: string;
            };
            EndpointSubscription: {
                DATA_TYPE: "endpoint_subscription#1.0.0";
                subscription_id: null
                | string;
            };
            EndpointSubscription_1_0_0: {
                DATA_TYPE: "endpoint_subscription#1.0.0";
                subscription_id: null
                | string;
            };
            ExpressionIdentityMapping_1_0_0: {
                DATA_TYPE: "expression_identity_mapping#1.0.0";
                mappings?: {
                    ignore_case?: boolean;
                    literal?: boolean;
                    match?: string;
                    output?: string;
                    source?: string;
                }[];
            };
            ExternalIdentityMapping_1_0_0: {
                command?: string[];
                DATA_TYPE: "external_identity_mapping#1.0.0";
            };
            Flow: { flow: string };
            FlowAssociation: { transfer?: unknown };
            FlowTransferAssociation: { destination?: unknown; source?: unknown };
            GoogleCloudStorageCollectionPolicies: {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            };
            GoogleCloudStorageCollectionPolicies_1_0_0: {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            };
            GoogleCloudStoragePolicies: | {
                auth_callback?: string;
                buckets?: null
                | string[];
                client_id: null | string;
                DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                projects?: null | string[];
                secret: null | string;
                service_account_key?: null | Record<string, unknown>;
                user_credential_required?: boolean;
            }
            | {
                allow_any_account?: boolean;
                auth_callback?: string;
                buckets?: null
                | string[];
                client_id: null | string;
                DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                projects?: null | string[];
                secret: null | string;
                service_account_key?: null | Record<string, unknown>;
                user_credential_required?: boolean;
            };
            GoogleCloudStoragePolicies_1_0_0: {
                auth_callback?: string;
                buckets?: null
                | string[];
                client_id: null | string;
                DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                projects?: null | string[];
                secret: null | string;
                service_account_key?: null | Record<string, unknown>;
                user_credential_required?: boolean;
            };
            GoogleCloudStoragePolicies_1_1_0: {
                allow_any_account?: boolean;
                auth_callback?: string;
                buckets?: null
                | string[];
                client_id: null | string;
                DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                projects?: null | string[];
                secret: null | string;
                service_account_key?: null | Record<string, unknown>;
                user_credential_required?: boolean;
            };
            GoogleCloudStorageProject: { name?: string; projectId?: string };
            GoogleCloudStorageUserCredentialPolicies: {
                access_token?: null | string;
                DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                email?: string;
                projects?: { name?: string; projectId?: string }[];
                refresh_token?: null | string;
                scopes?: string[];
                sub?: string;
                token_expiry?: string;
            };
            GoogleCloudStorageUserCredentialPolicies_1_0_0: {
                access_token?: null
                | string;
                DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                email?: string;
                projects?: { name?: string; projectId?: string }[];
                refresh_token?: null | string;
                scopes?: string[];
                sub?: string;
                token_expiry?: string;
            };
            GoogleDriveCollectionPolicies: {
                DATA_TYPE: "google_drive_collection_policies#1.0.0";
            };
            GoogleDriveCollectionPolicies_1_0_0: {
                DATA_TYPE: "google_drive_collection_policies#1.0.0";
            };
            GoogleDriveStoragePolicies: | {
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "google_drive_storage_policies#1.0.0";
                secret: null | string;
                user_api_rate_quota?: number;
            }
            | {
                allow_any_account?: boolean;
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "google_drive_storage_policies#1.1.0";
                secret: null | string;
                user_api_rate_quota?: number;
            };
            GoogleDriveStoragePolicies_1_0_0: {
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "google_drive_storage_policies#1.0.0";
                secret: null | string;
                user_api_rate_quota?: number;
            };
            GoogleDriveStoragePolicies_1_1_0: {
                allow_any_account?: boolean;
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "google_drive_storage_policies#1.1.0";
                secret: null | string;
                user_api_rate_quota?: number;
            };
            GoogleDriveUserCredentialPolicies: {
                access_token?: null
                | string;
                DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                token_expiry?: string;
            };
            GoogleDriveUserCredentialPolicies_1_0_0: {
                access_token?: null
                | string;
                DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                token_expiry?: string;
            };
            HPSSCollectionPolicies: { DATA_TYPE: "hpss_collection_policies#1.0.0" };
            HPSSCollectionPolicies_1_0_0: {
                DATA_TYPE: "hpss_collection_policies#1.0.0";
            };
            HPSSStoragePolicies: | {
                authentication_mech: "krb5"
                | "unix";
                authenticator: string;
                DATA_TYPE: "hpss_storage_policies#1.0.0";
                uda_checksum: boolean;
            }
            | {
                authentication_mech: "krb5"
                | "unix";
                authenticator: string;
                DATA_TYPE: "hpss_storage_policies#1.1.0";
                login_name?: string;
                uda_checksum: boolean;
            };
            HPSSStoragePolicies_1_0_0: {
                authentication_mech: "krb5"
                | "unix";
                authenticator: string;
                DATA_TYPE: "hpss_storage_policies#1.0.0";
                uda_checksum: boolean;
            };
            HPSSStoragePolicies_1_1_0: {
                authentication_mech: "krb5"
                | "unix";
                authenticator: string;
                DATA_TYPE: "hpss_storage_policies#1.1.0";
                login_name?: string;
                uda_checksum: boolean;
            };
            HPSSUserCredentialPolicies: {
                DATA_TYPE: "hpss_user_credential_policies#1.0.0";
            };
            HPSSUserCredentialPolicies_1_0_0: {
                DATA_TYPE: "hpss_user_credential_policies#1.0.0";
            };
            IdentityMapping: | {
                command?: string[];
                DATA_TYPE: "external_identity_mapping#1.0.0";
            }
            | {
                DATA_TYPE: "expression_identity_mapping#1.0.0";
                mappings?: {
                    ignore_case?: boolean;
                    literal?: boolean;
                    match?: string;
                    output?: string;
                    source?: string;
                }[];
            };
            IdNotInIdentitySet: {
                DATA_TYPE: "id_not_in_identity_set#1.0.0";
                id?: string;
            };
            IdNotInIdentitySet_1_0_0: {
                DATA_TYPE: "id_not_in_identity_set#1.0.0";
                id?: string;
            };
            Info: {
                api_version?: string;
                client_id?: string;
                DATA_TYPE: "info#1.0.0";
                domain_name?: string;
                endpoint_id?: string;
                manager_version?: string;
            };
            Info_1_0_0: {
                api_version?: string;
                client_id?: string;
                DATA_TYPE: "info#1.0.0";
                domain_name?: string;
                endpoint_id?: string;
                manager_version?: string;
            };
            InvalidCredential: {
                DATA_TYPE: "invalid_credential#1.0.0";
                user_credential_id: string;
            };
            InvalidCredential_1_0_0: {
                DATA_TYPE: "invalid_credential#1.0.0";
                user_credential_id: string;
            };
            InvalidInput: {
                DATA_TYPE: "invalid_input#1.0.0";
                errors?: { message: string; property?: string }[];
            };
            InvalidInput_1_0_0: {
                DATA_TYPE: "invalid_input#1.0.0";
                errors?: { message: string; property?: string }[];
            };
            InvalidInputItem: { message: string; property?: string };
            InvalidUser: { DATA_TYPE: "invalid_user#1.0.0"; usernames?: string[] };
            InvalidUser_1_0_0: {
                DATA_TYPE: "invalid_user#1.0.0";
                usernames?: string[];
            };
            IrodsCollectionPolicies: { DATA_TYPE: "irods_collection_policies#1.0.0" };
            IrodsCollectionPolicies_1_0_0: {
                DATA_TYPE: "irods_collection_policies#1.0.0";
            };
            IrodsEnvironment: { name: string; value: string };
            IrodsStoragePolicies: {
                DATA_TYPE: "irods_storage_policies#1.0.0";
                environment?: { name: string; value: string }[];
                irods_authentication_file?: string;
                irods_environment_file: string;
            };
            IrodsStoragePolicies_1_0_0: {
                DATA_TYPE: "irods_storage_policies#1.0.0";
                environment?: { name: string; value: string }[];
                irods_authentication_file?: string;
                irods_environment_file: string;
            };
            IrodsUserCredentialPolicies: {
                DATA_TYPE: "irods_user_credential_policies#1.0.0";
            };
            IrodsUserCredentialPolicies_1_0_0: {
                DATA_TYPE: "irods_user_credential_policies#1.0.0";
            };
            LimitExceeded: { DATA_TYPE: "limit_exceeded#1.0.0" };
            LimitExceeded_1_0_0: { DATA_TYPE: "limit_exceeded#1.0.0" };
            MappingExpression: {
                ignore_case?: boolean;
                literal?: boolean;
                match?: string;
                output?: string;
                source?: string;
            };
            MissingRequiredRole: {
                DATA_TYPE: "missing_required_role#1.0.0";
                roles?: {
                    collection?: string;
                    role: | "owner"
                    | "administrator"
                    | "access_manager"
                    | "activity_manager"
                    | "activity_monitor"
                    | "access_monitor";
                }[];
            };
            MissingRequiredRole_1_0_0: {
                DATA_TYPE: "missing_required_role#1.0.0";
                roles?: {
                    collection?: string;
                    role: | "owner"
                    | "administrator"
                    | "access_manager"
                    | "activity_manager"
                    | "activity_monitor"
                    | "access_monitor";
                }[];
            };
            MissingRequiredScopes: {
                DATA_TYPE: "missing_required_scopes#1.0.0";
                required_scopes?: string[];
            };
            MissingRequiredScopes_1_0_0: {
                DATA_TYPE: "missing_required_scopes#1.0.0";
                required_scopes?: string[];
            };
            MissingRoleEntrySchema: {
                collection?: string;
                role: | "owner"
                | "administrator"
                | "access_manager"
                | "activity_manager"
                | "activity_monitor"
                | "access_monitor";
            };
            Node: | {
                DATA_TYPE: "node#1.0.0";
                id?: string;
                incoming_port_range?: number[];
                ip_addresses: string[];
                outgoing_port_range?: number[];
                status: "active"
                | "inactive";
            }
            | {
                data_interface?: null
                | string;
                DATA_TYPE: "node#1.1.0";
                id?: string;
                incoming_port_range?: number[];
                ip_addresses: string[];
                outgoing_port_range?: number[];
                status: "active" | "inactive";
            }
            | {
                data_interface?: null
                | string;
                data_interface6?: null | string;
                DATA_TYPE: "node#1.2.0";
                id?: string;
                incoming_port_range?: number[];
                ip_addresses: string[];
                outgoing_port_range?: number[];
                status: "active" | "inactive";
            };
            Node_1_0_0: {
                DATA_TYPE: "node#1.0.0";
                id?: string;
                incoming_port_range?: number[];
                ip_addresses: string[];
                outgoing_port_range?: number[];
                status: "active"
                | "inactive";
            };
            Node_1_1_0: {
                data_interface?: null
                | string;
                DATA_TYPE: "node#1.1.0";
                id?: string;
                incoming_port_range?: number[];
                ip_addresses: string[];
                outgoing_port_range?: number[];
                status: "active" | "inactive";
            };
            Node_1_2_0: {
                data_interface?: null
                | string;
                data_interface6?: null | string;
                DATA_TYPE: "node#1.2.0";
                id?: string;
                incoming_port_range?: number[];
                ip_addresses: string[];
                outgoing_port_range?: number[];
                status: "active" | "inactive";
            };
            NotFromAllowedDomain: {
                allowed_domains?: string[];
                DATA_TYPE: "not_from_allowed_domain#1.0.0";
            };
            NotFromAllowedDomain_1_0_0: {
                allowed_domains?: string[];
                DATA_TYPE: "not_from_allowed_domain#1.0.0";
            };
            NotResourceOwner: { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
            NotResourceOwner_1_0_0: {
                DATA_TYPE: "not_resource_owner#1.0.0";
                id?: string;
            };
            OAuthUserCredentialForm: {
                access_token?: string;
                identity_id: string;
                login_hint?: string;
                redirect_uri: string;
                storage_gateway: string;
            };
            OneDriveCollectionPolicies: {
                DATA_TYPE: "onedrive_collection_policies#1.0.0";
            };
            OneDriveCollectionPolicies_1_0_0: {
                DATA_TYPE: "onedrive_collection_policies#1.0.0";
            };
            OneDriveStoragePolicies: | {
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "onedrive_storage_policies#1.0.0";
                secret: null | string;
                tenant?: null | string;
                user_api_rate_limit?: number;
            }
            | {
                allow_any_account?: boolean;
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "onedrive_storage_policies#1.1.0";
                secret: null | string;
                tenant?: null | string;
                user_api_rate_limit?: number;
            };
            OneDriveStoragePolicies_1_0_0: {
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "onedrive_storage_policies#1.0.0";
                secret: null | string;
                tenant?: null | string;
                user_api_rate_limit?: number;
            };
            OneDriveStoragePolicies_1_1_0: {
                allow_any_account?: boolean;
                auth_callback?: string;
                client_id: null
                | string;
                DATA_TYPE: "onedrive_storage_policies#1.1.0";
                secret: null | string;
                tenant?: null | string;
                user_api_rate_limit?: number;
            };
            OneDriveUserCredentialPolicies: {
                access_token?: null
                | string;
                DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                tid?: string;
                token_expiry?: string;
            };
            OneDriveUserCredentialPolicies_1_0_0: {
                access_token?: null
                | string;
                DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                email?: null | string;
                refresh_token?: null | string;
                scopes?: string[];
                sub?: null | string;
                tid?: string;
                token_expiry?: string;
            };
            OwnerString: { DATA_TYPE: "owner_string#1.0.0"; identity_id?: string };
            OwnerString_1_0_0: {
                DATA_TYPE: "owner_string#1.0.0";
                identity_id?: string;
            };
            PathRestrictions: {
                DATA_TYPE: "path_restrictions#1.0.0";
                none?: string[];
                read?: string[];
                read_write?: string[];
            };
            PathRestrictions_1_0_0: {
                DATA_TYPE: "path_restrictions#1.0.0";
                none?: string[];
                read?: string[];
                read_write?: string[];
            };
            PosixCollectionPolicies: | {
                DATA_TYPE: "posix_collection_policies#1.0.0";
            }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            };
            PosixCollectionPolicies_1_0_0: {
                DATA_TYPE: "posix_collection_policies#1.0.0";
            };
            PosixCollectionPolicies_1_1_0: {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            };
            PosixStagingCollectionPolicies: {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            };
            PosixStagingCollectionPolicies_1_0_0: {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            };
            PosixStagingEnvironment: { name: string; value: string };
            PosixStagingStoragePolicies: {
                DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                environment?: { name: string; value: string }[];
                groups_allow?: null | string[];
                groups_deny?: null | string[];
                stage_app: string;
            };
            PosixStagingStoragePolicies_1_0_0: {
                DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                environment?: { name: string; value: string }[];
                groups_allow?: null | string[];
                groups_deny?: null | string[];
                stage_app: string;
            };
            PosixStagingUserCredentialPolicies: {
                DATA_TYPE: "posix_staging_user_credential_policies#1.0.0";
            };
            PosixStagingUserCredentialPolicies_1_0_0: {
                DATA_TYPE: "posix_staging_user_credential_policies#1.0.0";
            };
            PosixStoragePolicies: {
                DATA_TYPE: "posix_storage_policies#1.0.0";
                groups_allow?: null
                | string[];
                groups_deny?: null | string[];
            };
            PosixStoragePolicies_1_0_0: {
                DATA_TYPE: "posix_storage_policies#1.0.0";
                groups_allow?: null
                | string[];
                groups_deny?: null | string[];
            };
            PosixUserCredentialPolicies: {
                DATA_TYPE: "posix_user_credential_policies#1.0.0";
            };
            PosixUserCredentialPolicies_1_0_0: {
                DATA_TYPE: "posix_user_credential_policies#1.0.0";
            };
            ResourceConflict: {
                DATA_TYPE: "resource_conflict#1.0.0";
                resources?: string[];
            };
            ResourceConflict_1_0_0: {
                DATA_TYPE: "resource_conflict#1.0.0";
                resources?: string[];
            };
            Result: | {
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.0.0";
                detail?: unknown;
                has_next_page: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            }
            | {
                authorization_parameters?: null
                | { [key: string]: unknown };
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.1.0";
                detail?: unknown;
                has_next_page: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            };
            Result_1_0_0: {
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.0.0";
                detail?: unknown;
                has_next_page: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            };
            Result_1_1_0: {
                authorization_parameters?: null
                | { [key: string]: unknown };
                code: string;
                data?: Record<string, unknown>[];
                DATA_TYPE: "result#1.1.0";
                detail?: unknown;
                has_next_page: boolean;
                http_response_code: number;
                marker?: null | string;
                message?: string;
            };
            Role: {
                collection?: null
                | string;
                DATA_TYPE: "role#1.0.0";
                id?: string;
                principal: string;
                role:
                    | "owner"
                    | "administrator"
                    | "access_manager"
                    | "activity_manager"
                    | "activity_monitor"
                    | "access_monitor";
            };
            Role_1_0_0: {
                collection?: null
                | string;
                DATA_TYPE: "role#1.0.0";
                id?: string;
                principal: string;
                role:
                    | "owner"
                    | "administrator"
                    | "access_manager"
                    | "activity_manager"
                    | "activity_monitor"
                    | "access_monitor";
            };
            S3CollectionPolicies: { DATA_TYPE: "s3_collection_policies#1.0.0" };
            S3CollectionPolicies_1_0_0: { DATA_TYPE: "s3_collection_policies#1.0.0" };
            S3KeysPrefixPaths_1_0_0: {
                path_prefixes: string[];
                s3_key_id?: null | string;
                s3_secret_key?: null | string;
            };
            S3StoragePolicies: | {
                DATA_TYPE: "s3_storage_policies#1.0.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_user_credential_required?: boolean;
            }
            | {
                DATA_TYPE: "s3_storage_policies#1.1.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_requester_pays?: boolean;
                s3_user_credential_required?: boolean;
            }
            | {
                DATA_TYPE: "s3_storage_policies#1.2.0";
                s3_allow_multi_keys?: boolean;
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_requester_pays?: boolean;
                s3_user_credential_required?: boolean;
            };
            S3StoragePolicies_1_0_0: {
                DATA_TYPE: "s3_storage_policies#1.0.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_user_credential_required?: boolean;
            };
            S3StoragePolicies_1_1_0: {
                DATA_TYPE: "s3_storage_policies#1.1.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_requester_pays?: boolean;
                s3_user_credential_required?: boolean;
            };
            S3StoragePolicies_1_2_0: {
                DATA_TYPE: "s3_storage_policies#1.2.0";
                s3_allow_multi_keys?: boolean;
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_requester_pays?: boolean;
                s3_user_credential_required?: boolean;
            };
            S3UserCredentialPolicies: | {
                DATA_TYPE: "s3_user_credential_policies#1.0.0";
                s3_key_id?: null
                | string;
                s3_secret_key?: null | string;
            }
            | {
                DATA_TYPE: "s3_user_credential_policies#1.1.0";
                s3_key_id?: null
                | string;
                s3_requester_pays?: boolean;
                s3_secret_key?: null | string;
            }
            | {
                DATA_TYPE: "s3_user_credential_policies#1.2.0";
                s3_key_id?: null
                | string;
                s3_multi_keys?:
                    | null
                    | {
                        path_prefixes: string[];
                        s3_key_id?: null
                        | string;
                        s3_secret_key?: null | string;
                    }[];
                s3_requester_pays?: boolean;
                s3_secret_key?: null
                | string;
            };
            S3UserCredentialPolicies_1_0_0: {
                DATA_TYPE: "s3_user_credential_policies#1.0.0";
                s3_key_id?: null
                | string;
                s3_secret_key?: null | string;
            };
            S3UserCredentialPolicies_1_1_0: {
                DATA_TYPE: "s3_user_credential_policies#1.1.0";
                s3_key_id?: null
                | string;
                s3_requester_pays?: boolean;
                s3_secret_key?: null | string;
            };
            S3UserCredentialPolicies_1_2_0: {
                DATA_TYPE: "s3_user_credential_policies#1.2.0";
                s3_key_id?: null
                | string;
                s3_multi_keys?:
                    | null
                    | {
                        path_prefixes: string[];
                        s3_key_id?: null
                        | string;
                        s3_secret_key?: null | string;
                    }[];
                s3_requester_pays?: boolean;
                s3_secret_key?: null
                | string;
            };
            SharingPolicy: {
                collection_id: string;
                DATA_TYPE: "sharing_policy#1.0.0";
                id?: string;
                sharing_restrict_paths: {
                    DATA_TYPE: "path_restrictions#1.0.0";
                    none?: string[];
                    read?: string[];
                    read_write?: string[];
                };
                users?: string[];
            };
            SharingPolicy_1_0_0: {
                collection_id: string;
                DATA_TYPE: "sharing_policy#1.0.0";
                id?: string;
                sharing_restrict_paths: {
                    DATA_TYPE: "path_restrictions#1.0.0";
                    none?: string[];
                    read?: string[];
                    read_write?: string[];
                };
                users?: string[];
            };
            StorageGateway: | {
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.0.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            }
            | {
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.1.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            }
            | {
                admin_managed_credentials: boolean;
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.2.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            }
            | {
                admin_managed_credentials: boolean;
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.3.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                max_concurrency?: number;
                max_parallelism?: number;
                network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            };
            StorageGateway_1_0_0: {
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.0.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: boolean;
                                literal?: boolean;
                                match?: string;
                                output?: string;
                                source?: string;
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            };
            StorageGateway_1_1_0: {
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.1.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: boolean;
                                literal?: boolean;
                                match?: string;
                                output?: string;
                                source?: string;
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            };
            StorageGateway_1_2_0: {
                admin_managed_credentials: boolean;
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.2.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: boolean;
                                literal?: boolean;
                                match?: string;
                                output?: string;
                                source?: string;
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            };
            StorageGateway_1_3_0: {
                admin_managed_credentials: boolean;
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.3.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: boolean;
                                literal?: boolean;
                                match?: string;
                                output?: string;
                                source?: string;
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                max_concurrency?: number;
                max_parallelism?: number;
                network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            };
            StorageGatewayNotFound: {
                DATA_TYPE: "storage_gateway_not_found#1.0.0";
                storage_gateway_id?: string;
            };
            StorageGatewayNotFound_1_0_0: {
                DATA_TYPE: "storage_gateway_not_found#1.0.0";
                storage_gateway_id?: string;
            };
            SubscriptionAdminVerified: {
                DATA_TYPE: "subscription_admin_verified#1.0.0";
                subscription_admin_verified: boolean;
            };
            SubscriptionAdminVerified_1_0_0: {
                DATA_TYPE: "subscription_admin_verified#1.0.0";
                subscription_admin_verified: boolean;
            };
            SubscriptionRequired: {
                add_ons?: string[];
                DATA_TYPE: "subscription_required#1.0.0";
                subscription_level?: string;
            };
            SubscriptionRequired_1_0_0: {
                add_ons?: string[];
                DATA_TYPE: "subscription_required#1.0.0";
                subscription_level?: string;
            };
            UserCredential: {
                connector_id?: string;
                DATA_TYPE: "user_credential#1.0.0";
                deleted?: boolean;
                display_name?: null
                | string;
                home_directory?: string;
                id?: string;
                identity_id?: string;
                invalid?: boolean;
                policies?:
                    | {
                        DATA_TYPE: "s3_user_credential_policies#1.0.0";
                        s3_key_id?: null
                        | string;
                        s3_secret_key?: null | string;
                    }
                    | {
                        DATA_TYPE: "s3_user_credential_policies#1.1.0";
                        s3_key_id?: null
                        | string;
                        s3_requester_pays?: boolean;
                        s3_secret_key?: null | string;
                    }
                    | {
                        DATA_TYPE: "s3_user_credential_policies#1.2.0";
                        s3_key_id?: null
                        | string;
                        s3_multi_keys?:
                            | null
                            | {
                                path_prefixes: string[];
                                s3_key_id?: null
                                | string;
                                s3_secret_key?: null | string;
                            }[];
                        s3_requester_pays?: boolean;
                        s3_secret_key?: null
                        | string;
                    }
                    | {
                        access_token?: null
                        | string;
                        DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        tid?: string;
                        token_expiry?: string;
                    }
                    | {
                        access_id?: string;
                        DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                        secret_key?: string;
                    }
                    | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                    | {
                        access_token?: null | string;
                        DATA_TYPE: "box_user_credential_policies#1.1.0";
                        email?: null | string;
                        max_upload?: number;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        token_expiry?: string;
                    }
                    | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                    | {
                        access_token?: null | string;
                        DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        root_info?: Record<string, unknown>;
                        scopes?: string[];
                        sub?: null | string;
                        token_expiry?: string;
                    }
                    | {
                        access_token?: null
                        | string;
                        DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                        email?: string;
                        projects?: { name?: string; projectId?: string }[];
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: string;
                        token_expiry?: string;
                    }
                    | {
                        access_token?: null
                        | string;
                        DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        token_expiry?: string;
                    }
                    | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                    | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                    | {
                        access_token?: null | string;
                        DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        tid?: string;
                        token_expiry?: string;
                    }
                    | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                    | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
                provisioned?: boolean;
                storage_gateway_id?: string;
                username?: string;
            };
            UserCredential_1_0_0: {
                connector_id?: string;
                DATA_TYPE: "user_credential#1.0.0";
                deleted?: boolean;
                display_name?: null
                | string;
                home_directory?: string;
                id?: string;
                identity_id?: string;
                invalid?: boolean;
                policies?:
                    | {
                        DATA_TYPE: "s3_user_credential_policies#1.0.0";
                        s3_key_id?: null
                        | string;
                        s3_secret_key?: null | string;
                    }
                    | {
                        DATA_TYPE: "s3_user_credential_policies#1.1.0";
                        s3_key_id?: null
                        | string;
                        s3_requester_pays?: boolean;
                        s3_secret_key?: null | string;
                    }
                    | {
                        DATA_TYPE: "s3_user_credential_policies#1.2.0";
                        s3_key_id?: null
                        | string;
                        s3_multi_keys?:
                            | null
                            | {
                                path_prefixes: string[];
                                s3_key_id?: null
                                | string;
                                s3_secret_key?: null | string;
                            }[];
                        s3_requester_pays?: boolean;
                        s3_secret_key?: null
                        | string;
                    }
                    | {
                        access_token?: null
                        | string;
                        DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        tid?: string;
                        token_expiry?: string;
                    }
                    | {
                        access_id?: string;
                        DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                        secret_key?: string;
                    }
                    | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                    | {
                        access_token?: null | string;
                        DATA_TYPE: "box_user_credential_policies#1.1.0";
                        email?: null | string;
                        max_upload?: number;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        token_expiry?: string;
                    }
                    | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                    | {
                        access_token?: null | string;
                        DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        root_info?: Record<string, unknown>;
                        scopes?: string[];
                        sub?: null | string;
                        token_expiry?: string;
                    }
                    | {
                        access_token?: null
                        | string;
                        DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                        email?: string;
                        projects?: { name?: string; projectId?: string }[];
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: string;
                        token_expiry?: string;
                    }
                    | {
                        access_token?: null
                        | string;
                        DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        token_expiry?: string;
                    }
                    | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                    | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                    | {
                        access_token?: null | string;
                        DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                        email?: null | string;
                        refresh_token?: null | string;
                        scopes?: string[];
                        sub?: null | string;
                        tid?: string;
                        token_expiry?: string;
                    }
                    | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                    | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
                provisioned?: boolean;
                storage_gateway_id?: string;
                username?: string;
            };
        };
    }
    Index

    Properties

    headers: never
    parameters: {
        collection_id_query_parameter: string;
        marker_query_parameter: string;
        page_size_query_parameter: number;
    }

    Type declaration

    • collection_id_query_parameter: string

      ID of the collection

    • marker_query_parameter: string

      Pagination marker for a paginated response

    • page_size_query_parameter: number

      Maximum page size for a paginated response

    pathItems: never
    requestBodies: never
    responses: {
        BadRequestError: {
            content: {
                "application/json": { code?: "bad_request"; http_response_code?: 400 } & (
                    | {
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.0.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                    | {
                        authorization_parameters?: null
                        | { [key: string]: unknown };
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.1.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                );
            };
            headers: { [name: string]: unknown };
        };
        NotFound: {
            content: {
                "application/json": { code?: "not_found"; http_response_code?: 404 } & (
                    | {
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.0.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                    | {
                        authorization_parameters?: null
                        | { [key: string]: unknown };
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.1.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                );
            };
            headers: { [name: string]: unknown };
        };
        Unauthorized: {
            content: {
                "application/json": {
                    code?: "not_authorized";
                    detail?: | string
                    | {
                        DATA_TYPE: "missing_required_scopes#1.0.0";
                        required_scopes?: string[];
                    };
                    http_response_code?: 401;
                } & (
                    | {
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.0.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                    | {
                        authorization_parameters?: null
                        | { [key: string]: unknown };
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.1.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                );
            };
            headers: { [name: string]: unknown };
        };
        UnsupportedMediaError: {
            content: {
                "application/json": {
                    code?: "unsupported_media_type";
                    http_response_code?: 415;
                } & (
                    | {
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.0.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                    | {
                        authorization_parameters?: null
                        | { [key: string]: unknown };
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.1.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                );
            };
            headers: { [name: string]: unknown };
        };
        ValidationError: {
            content: {
                "application/json": {
                    code?: "unprocessable_entity";
                    detail?: | string
                    | {
                        DATA_TYPE: "invalid_input#1.0.0";
                        errors?: { message: string; property?: (...)
                        | (...) }[];
                    };
                    http_response_code?: 422;
                } & (
                    | {
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.0.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                    | {
                        authorization_parameters?: null
                        | { [key: string]: unknown };
                        code: string;
                        data?: Record<string, unknown>[];
                        DATA_TYPE: "result#1.1.0";
                        detail?: unknown;
                        has_next_page: boolean;
                        http_response_code: number;
                        marker?: null | string;
                        message?: string;
                    }
                );
            };
            headers: { [name: string]: unknown };
        };
    }

    Type declaration

    • BadRequestError: {
          content: {
              "application/json": { code?: "bad_request"; http_response_code?: 400 } & (
                  | {
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.0.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
                  | {
                      authorization_parameters?: null
                      | { [key: string]: unknown };
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.1.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
              );
          };
          headers: { [name: string]: unknown };
      }

      Bad Request

    • NotFound: {
          content: {
              "application/json": { code?: "not_found"; http_response_code?: 404 } & (
                  | {
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.0.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
                  | {
                      authorization_parameters?: null
                      | { [key: string]: unknown };
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.1.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
              );
          };
          headers: { [name: string]: unknown };
      }

      Not found

    • Unauthorized: {
          content: {
              "application/json": {
                  code?: "not_authorized";
                  detail?:
                      | string
                      | {
                          DATA_TYPE: "missing_required_scopes#1.0.0";
                          required_scopes?: string[];
                      };
                  http_response_code?: 401;
              } & (
                  | {
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.0.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
                  | {
                      authorization_parameters?: null
                      | { [key: string]: unknown };
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.1.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
              );
          };
          headers: { [name: string]: unknown };
      }

      Unauthorized

    • UnsupportedMediaError: {
          content: {
              "application/json": {
                  code?: "unsupported_media_type";
                  http_response_code?: 415;
              } & (
                  | {
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.0.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
                  | {
                      authorization_parameters?: null
                      | { [key: string]: unknown };
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.1.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
              );
          };
          headers: { [name: string]: unknown };
      }

      Unsupported media type

    • ValidationError: {
          content: {
              "application/json": {
                  code?: "unprocessable_entity";
                  detail?:
                      | string
                      | {
                          DATA_TYPE: "invalid_input#1.0.0";
                          errors?: { message: string; property?: (...)
                          | (...) }[];
                      };
                  http_response_code?: 422;
              } & (
                  | {
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.0.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
                  | {
                      authorization_parameters?: null
                      | { [key: string]: unknown };
                      code: string;
                      data?: Record<string, unknown>[];
                      DATA_TYPE: "result#1.1.0";
                      detail?: unknown;
                      has_next_page: boolean;
                      http_response_code: number;
                      marker?: null | string;
                      message?: string;
                  }
              );
          };
          headers: { [name: string]: unknown };
      }

      Unprocessable entity

    schemas: {
        Account: {
            DATA_TYPE: "account#1.0.0";
            identity_id?: string;
            storage_gateway_id?: string;
            username?: string;
        };
        Account_1_0_0: {
            DATA_TYPE: "account#1.0.0";
            identity_id?: string;
            storage_gateway_id?: string;
            username?: string;
        };
        ActiveScaleCollectionPolicies: {
            DATA_TYPE: "s3_collection_policies#1.0.0";
        };
        ActiveScaleStoragePolicies: {
            DATA_TYPE: "s3_storage_policies#1.0.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_user_credential_required?: boolean;
        };
        ActiveScaleUserCredentialPolicies: {
            DATA_TYPE: "s3_user_credential_policies#1.0.0";
            s3_key_id?: null
            | string;
            s3_secret_key?: null | string;
        };
        ActivityNotificationPolicy: { status: string[]; transfer_use: string[] };
        AuthenticationTimeout:
            | {
                DATA_TYPE: "authentication_timeout#1.0.0";
                high_assurance?: boolean;
                identities?: string[];
            }
            | {
                DATA_TYPE: "authentication_timeout#1.1.0";
                high_assurance?: boolean;
                identities?: string[];
                require_mfa?: boolean;
            };
        AuthenticationTimeout_1_0_0: {
            DATA_TYPE: "authentication_timeout#1.0.0";
            high_assurance?: boolean;
            identities?: string[];
        };
        AuthenticationTimeout_1_1_0: {
            DATA_TYPE: "authentication_timeout#1.1.0";
            high_assurance?: boolean;
            identities?: string[];
            require_mfa?: boolean;
        };
        AzureBlobCollectionPolicies: {
            DATA_TYPE: "azure_blob_collection_policies#1.0.0";
        };
        AzureBlobCollectionPolicies_1_0_0: {
            DATA_TYPE: "azure_blob_collection_policies#1.0.0";
        };
        AzureBlobStoragePolicies: | {
            account: null
            | string;
            adls: null | boolean;
            auth_callback?: string;
            auth_type: null | string;
            client_id: null | string;
            DATA_TYPE: "azure_blob_storage_policies#1.0.0";
            secret: null | string;
            tenant: null | string;
            user_credential_required?: boolean;
        }
        | {
            account: null
            | string;
            adls: null | boolean;
            allow_any_account?: boolean;
            auth_callback?: string;
            auth_type: null | string;
            client_id: null | string;
            DATA_TYPE: "azure_blob_storage_policies#1.1.0";
            secret: null | string;
            tenant: null | string;
            user_credential_required?: boolean;
        };
        AzureBlobStoragePolicies_1_0_0: {
            account: null
            | string;
            adls: null | boolean;
            auth_callback?: string;
            auth_type: null | string;
            client_id: null | string;
            DATA_TYPE: "azure_blob_storage_policies#1.0.0";
            secret: null | string;
            tenant: null | string;
            user_credential_required?: boolean;
        };
        AzureBlobStoragePolicies_1_1_0: {
            account: null
            | string;
            adls: null | boolean;
            allow_any_account?: boolean;
            auth_callback?: string;
            auth_type: null | string;
            client_id: null | string;
            DATA_TYPE: "azure_blob_storage_policies#1.1.0";
            secret: null | string;
            tenant: null | string;
            user_credential_required?: boolean;
        };
        AzureBlobUserCredentialPolicies: {
            access_token?: null
            | string;
            DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            tid?: string;
            token_expiry?: string;
        };
        AzureBlobUserCredentialPolicies_1_0_0: {
            access_token?: null
            | string;
            DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            tid?: string;
            token_expiry?: string;
        };
        Batch: { DATA_TYPE: "batch#1.0.0"; ids?: string[] };
        Batch_1_0_0: { DATA_TYPE: "batch#1.0.0"; ids?: string[] };
        BlackPearlCollectionPolicies: {
            DATA_TYPE: "blackpearl_collection_policies#1.0.0";
        };
        BlackPearlCollectionPolicies_1_0_0: {
            DATA_TYPE: "blackpearl_collection_policies#1.0.0";
        };
        BlackPearlStoragePolicies: {
            bp_access_id_file?: string;
            DATA_TYPE: "blackpearl_storage_policies#1.0.0";
            s3_endpoint?: string;
        };
        BlackPearlStoragePolicies_1_0_0: {
            bp_access_id_file?: string;
            DATA_TYPE: "blackpearl_storage_policies#1.0.0";
            s3_endpoint?: string;
        };
        BlackPearlUserCredentialPolicies: {
            access_id?: string;
            DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
            secret_key?: string;
        };
        BlackPearlUserCredentialPolicies_1_0_0: {
            access_id?: string;
            DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
            secret_key?: string;
        };
        BoxAppAuth: { passphrase: string; privateKey: string; publicKeyID: string };
        BoxAppSettings: {
            appAuth: {
                passphrase: string;
                privateKey: string;
                publicKeyID: string;
            };
            clientID: string;
            clientSecret: string;
        };
        BoxCollectionPolicies: { DATA_TYPE: "box_collection_policies#1.0.0" };
        BoxCollectionPolicies_1_0_0: { DATA_TYPE: "box_collection_policies#1.0.0" };
        BoxStorage_1_0_0: {
            boxAppSettings: {
                appAuth: {
                    passphrase: string;
                    privateKey: string;
                    publicKeyID: string;
                };
                clientID: string;
                clientSecret: string;
            };
            DATA_TYPE: "box_storage_policies#1.0.0";
            enterpriseID: string;
        };
        BoxStorage_1_1_0: {
            auth_callback?: string;
            boxAppSettings?: {
                appAuth: {
                    passphrase: string;
                    privateKey: string;
                    publicKeyID: string;
                };
                clientID: string;
                clientSecret: string;
            };
            client_id?: string;
            DATA_TYPE: "box_storage_policies#1.1.0";
            enterpriseID?: string;
            secret?: string;
            user_api_rate_limit?: number;
            user_credential_required?: boolean;
        };
        BoxStorage_1_2_0: {
            allow_any_account?: boolean;
            auth_callback?: string;
            boxAppSettings?: {
                appAuth: {
                    passphrase: string;
                    privateKey: string;
                    publicKeyID: string;
                };
                clientID: string;
                clientSecret: string;
            };
            client_id?: string;
            DATA_TYPE: "box_storage_policies#1.2.0";
            enterpriseID?: string;
            secret?: string;
            user_api_rate_limit?: number;
            user_credential_required?: boolean;
        };
        BoxStoragePolicies: | {
            boxAppSettings: {
                appAuth: {
                    passphrase: string;
                    privateKey: string;
                    publicKeyID: string;
                };
                clientID: string;
                clientSecret: string;
            };
            DATA_TYPE: "box_storage_policies#1.0.0";
            enterpriseID: string;
        }
        | {
            auth_callback?: string;
            boxAppSettings?: {
                appAuth: {
                    passphrase: string;
                    privateKey: string;
                    publicKeyID: string;
                };
                clientID: string;
                clientSecret: string;
            };
            client_id?: string;
            DATA_TYPE: "box_storage_policies#1.1.0";
            enterpriseID?: string;
            secret?: string;
            user_api_rate_limit?: number;
            user_credential_required?: boolean;
        }
        | {
            allow_any_account?: boolean;
            auth_callback?: string;
            boxAppSettings?: {
                appAuth: {
                    passphrase: string;
                    privateKey: string;
                    publicKeyID: string;
                };
                clientID: string;
                clientSecret: string;
            };
            client_id?: string;
            DATA_TYPE: "box_storage_policies#1.2.0";
            enterpriseID?: string;
            secret?: string;
            user_api_rate_limit?: number;
            user_credential_required?: boolean;
        };
        BoxUserCredential_1_0_0: {
            DATA_TYPE: "box_user_credential_policies#1.0.0";
        };
        BoxUserCredential_1_1_0: {
            access_token?: null
            | string;
            DATA_TYPE: "box_user_credential_policies#1.1.0";
            email?: null | string;
            max_upload?: number;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            token_expiry?: string;
        };
        BoxUserCredentialPolicies: | {
            DATA_TYPE: "box_user_credential_policies#1.0.0";
        }
        | {
            access_token?: null
            | string;
            DATA_TYPE: "box_user_credential_policies#1.1.0";
            email?: null | string;
            max_upload?: number;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            token_expiry?: string;
        };
        CephCollectionPolicies: { DATA_TYPE: "ceph_collection_policies#1.0.0" };
        CephCollectionPolicies_1_0_0: {
            DATA_TYPE: "ceph_collection_policies#1.0.0";
        };
        CephStoragePolicies: {
            ceph_admin_key_id?: string;
            ceph_admin_secret_key?: string;
            DATA_TYPE: "ceph_storage_policies#1.0.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
        };
        CephStoragePolicies_1_0_0: {
            ceph_admin_key_id?: string;
            ceph_admin_secret_key?: string;
            DATA_TYPE: "ceph_storage_policies#1.0.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
        };
        CephUserCredentialPolicies: {
            DATA_TYPE: "ceph_user_credential_policies#1.0.0";
        };
        CephUserCredentialPolicies_1_0_0: {
            DATA_TYPE: "ceph_user_credential_policies#1.0.0";
        };
        CheckResult: {
            DATA_TYPE: "check_result#1.0.0";
            error?: null
            | Record<string, unknown>;
            id?: string;
            message?: string;
        };
        CheckResult_1_0_0: {
            DATA_TYPE: "check_result#1.0.0";
            error?: null
            | Record<string, unknown>;
            id?: string;
            message?: string;
        };
        Collection: | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.0.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain_name?: string;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.1.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null
            | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.2.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.3.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null
            | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.4.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null
            | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.5.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null
            | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.6.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.7.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.8.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.9.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.10.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.11.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.12.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            auto_delete_timeout?: null | number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.13.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            skip_auto_delete?: boolean;
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            acl_expiration_mins?: null
            | number;
            activity_notification_policy?: {
                status: string[];
                transfer_use: string[];
            };
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            auto_delete_timeout?: null
            | number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.14.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            skip_auto_delete?: boolean;
            storage_gateway_id?: string;
            subscription_admin_verified?: boolean;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        }
        | {
            acl_expiration_mins?: null
            | number;
            activity_notification_policy?: {
                status: string[];
                transfer_use: string[];
            };
            allow_guest_collections?: boolean;
            associated_flow_policy?: unknown;
            authentication_timeout_mins?: number;
            auto_delete_timeout?: null
            | number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.15.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            skip_auto_delete?: boolean;
            storage_gateway_id?: string;
            subscription_admin_verified?: boolean;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_0_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.0.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain_name?: string;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
        };
        Collection_1_1_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.1.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null
            | string;
            user_message_link?: null | string;
        };
        Collection_1_10_0: {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.10.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_11_0: {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.11.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_12_0: {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.12.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_13_0: {
            acl_expiration_mins?: null
            | number;
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            auto_delete_timeout?: null | number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.13.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            skip_auto_delete?: boolean;
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_14_0: {
            acl_expiration_mins?: null
            | number;
            activity_notification_policy?: {
                status: string[];
                transfer_use: string[];
            };
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            auto_delete_timeout?: null
            | number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.14.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            skip_auto_delete?: boolean;
            storage_gateway_id?: string;
            subscription_admin_verified?: boolean;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_15_0: {
            acl_expiration_mins?: null
            | number;
            activity_notification_policy?: {
                status: string[];
                transfer_use: string[];
            };
            allow_guest_collections?: boolean;
            associated_flow_policy?: unknown;
            authentication_timeout_mins?: number;
            auto_delete_timeout?: null
            | number;
            collection_base_path: string;
            collection_type: "mapped" | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.15.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            restrict_transfers_to_high_assurance?: | null
            | "inbound"
            | "outbound"
            | "all";
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            skip_auto_delete?: boolean;
            storage_gateway_id?: string;
            subscription_admin_verified?: boolean;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_2_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.2.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_3_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.3.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null
            | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_4_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.4.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null
            | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_5_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.5.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null
            | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_6_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.6.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_7_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.7.0";
            default_directory?: string;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_8_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            DATA_TYPE: "collection#1.8.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        Collection_1_9_0: {
            allow_guest_collections?: boolean;
            authentication_timeout_mins?: number;
            collection_base_path: string;
            collection_type: "mapped"
            | "guest";
            connector_id?: string;
            contact_email?: null | string;
            contact_info?: null | string;
            created_at?: null | string;
            DATA_TYPE: "collection#1.9.0";
            default_directory?: string;
            delete_protected?: boolean;
            deleted?: boolean;
            department?: null | string;
            description?: null | string;
            disable_anonymous_writes?: boolean;
            disable_verify?: boolean;
            display_name: string;
            domain?: {
                certificate?: null | string;
                certificate_chain?: null | string;
                certificate_chain_path?: null | string;
                certificate_path?: null | string;
                DATA_TYPE: "domain#1.0.0";
                domain_name: string;
                private_key?: null | string;
                private_key_path?: null | string;
                wildcard: boolean;
            };
            domain_name?: string;
            enable_https?: boolean;
            force_encryption?: boolean;
            force_verify?: boolean;
            guest_auth_policy_id?: null
            | string;
            high_assurance?: boolean;
            https_url?: string;
            id?: string;
            identity_id?: string;
            info_link?: null | string;
            keywords?: string[];
            last_access?: null | string;
            manager_url?: string;
            mapped_collection_id?: string;
            organization?: string;
            policies?:
                | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                | { DATA_TYPE: "box_collection_policies#1.0.0" }
                | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                    project?: string;
                }
                | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                | {
                    DATA_TYPE: "posix_collection_policies#1.1.0";
                    sharing_groups_allow?: null | string[];
                    sharing_groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                    sharing_groups_allow?: null
                    | string[];
                    sharing_groups_deny?: null | string[];
                };
            public: boolean;
            require_mfa?: boolean;
            root_path?: string;
            sharing_restrict_paths?: unknown;
            sharing_users_allow?: null
            | string[];
            sharing_users_deny?: null | string[];
            storage_gateway_id?: string;
            tlsftp_url?: string;
            user_credential_id?: string;
            user_message?: null | string;
            user_message_link?: null | string;
        };
        CollectionNotFound: {
            collection_id?: string;
            DATA_TYPE: "collection_not_found#1.0.0";
        };
        CollectionNotFound_1_0_0: {
            collection_id?: string;
            DATA_TYPE: "collection_not_found#1.0.0";
        };
        CollectionOwner: {
            DATA_TYPE: "collection_owner#1.0.0";
            identity_id: string;
        };
        CollectionOwner_1_0_0: {
            DATA_TYPE: "collection_owner#1.0.0";
            identity_id: string;
        };
        Connector: | {
            DATA_TYPE: "connector#1.0.0";
            display_name: string;
            id: string;
            version?: string;
        }
        | {
            DATA_TYPE: "connector#1.1.0";
            display_name: string;
            id: string;
            is_baa?: boolean;
            is_ha?: boolean;
            version?: string;
        };
        Connector_1_0_0: {
            DATA_TYPE: "connector#1.0.0";
            display_name: string;
            id: string;
            version?: string;
        };
        Connector_1_1_0: {
            DATA_TYPE: "connector#1.1.0";
            display_name: string;
            id: string;
            is_baa?: boolean;
            is_ha?: boolean;
            version?: string;
        };
        CredentialNotFound: {
            accounts: {
                DATA_TYPE: "account#1.0.0";
                identity_id?: string;
                storage_gateway_id?: string;
                username?: string;
            }[];
            DATA_TYPE: "credential_not_found#1.0.0";
        };
        CredentialNotFound_1_0_0: {
            accounts: {
                DATA_TYPE: "account#1.0.0";
                identity_id?: string;
                storage_gateway_id?: string;
                username?: string;
            }[];
            DATA_TYPE: "credential_not_found#1.0.0";
        };
        Domain: {
            certificate?: null
            | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        };
        Domain_1_0_0: {
            certificate?: null
            | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        };
        DropboxCollectionPolicies: {
            DATA_TYPE: "dropbox_collection_policies#1.0.0";
        };
        DropboxCollectionPolicies_1_0_0: {
            DATA_TYPE: "dropbox_collection_policies#1.0.0";
        };
        DropboxStoragePolicies: {
            allow_any_account?: boolean;
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "dropbox_storage_policies#1.0.0";
            secret: null | string;
            user_api_rate_limit?: number;
        };
        DropboxStoragePolicies_1_0_0: {
            allow_any_account?: boolean;
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "dropbox_storage_policies#1.0.0";
            secret: null | string;
            user_api_rate_limit?: number;
        };
        DropboxUserCredentialPolicies: {
            access_token?: null
            | string;
            DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            root_info?: Record<string, unknown>;
            scopes?: string[];
            sub?: null | string;
            token_expiry?: string;
        };
        DropboxUserCredentialPolicies_1_0_0: {
            access_token?: null
            | string;
            DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            root_info?: Record<string, unknown>;
            scopes?: string[];
            sub?: null | string;
            token_expiry?: string;
        };
        Endpoint: | {
            allow_udt?: boolean;
            contact_email?: string;
            contact_info?: string;
            DATA_TYPE: "endpoint#1.0.0";
            department?: string;
            description?: string;
            display_name: string;
            gcs_manager_url?: string;
            id?: string;
            info_link?: string;
            keywords?: string[];
            max_concurrency?: number;
            max_parallelism?: number;
            network_use: "normal"
            | "minimal"
            | "aggressive"
            | "custom";
            organization?: string;
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            public: boolean;
            subscription_id?: null | string;
        }
        | {
            allow_udt?: boolean;
            contact_email?: string;
            contact_info?: string;
            DATA_TYPE: "endpoint#1.1.0";
            department?: string;
            description?: string;
            display_name: string;
            gcs_manager_url?: string;
            gridftp_control_channel_port?: null
            | number;
            id?: string;
            info_link?: string;
            keywords?: string[];
            max_concurrency?: number;
            max_parallelism?: number;
            network_use: "normal" | "minimal" | "aggressive" | "custom";
            organization?: string;
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            public: boolean;
            subscription_id?: null | string;
        }
        | {
            allow_udt?: boolean;
            contact_email?: string;
            contact_info?: string;
            DATA_TYPE: "endpoint#1.2.0";
            department?: string;
            description?: string;
            display_name: string;
            earliest_last_access?: string;
            gcs_manager_url?: string;
            gridftp_control_channel_port?: null
            | number;
            id?: string;
            info_link?: string;
            keywords?: string[];
            max_concurrency?: number;
            max_parallelism?: number;
            network_use: "normal" | "minimal" | "aggressive" | "custom";
            organization?: string;
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            public: boolean;
            subscription_id?: null | string;
        };
        Endpoint_1_0_0: {
            allow_udt?: boolean;
            contact_email?: string;
            contact_info?: string;
            DATA_TYPE: "endpoint#1.0.0";
            department?: string;
            description?: string;
            display_name: string;
            gcs_manager_url?: string;
            id?: string;
            info_link?: string;
            keywords?: string[];
            max_concurrency?: number;
            max_parallelism?: number;
            network_use: "normal"
            | "minimal"
            | "aggressive"
            | "custom";
            organization?: string;
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            public: boolean;
            subscription_id?: null | string;
        };
        Endpoint_1_1_0: {
            allow_udt?: boolean;
            contact_email?: string;
            contact_info?: string;
            DATA_TYPE: "endpoint#1.1.0";
            department?: string;
            description?: string;
            display_name: string;
            gcs_manager_url?: string;
            gridftp_control_channel_port?: null
            | number;
            id?: string;
            info_link?: string;
            keywords?: string[];
            max_concurrency?: number;
            max_parallelism?: number;
            network_use: "normal" | "minimal" | "aggressive" | "custom";
            organization?: string;
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            public: boolean;
            subscription_id?: null | string;
        };
        Endpoint_1_2_0: {
            allow_udt?: boolean;
            contact_email?: string;
            contact_info?: string;
            DATA_TYPE: "endpoint#1.2.0";
            department?: string;
            description?: string;
            display_name: string;
            earliest_last_access?: string;
            gcs_manager_url?: string;
            gridftp_control_channel_port?: null
            | number;
            id?: string;
            info_link?: string;
            keywords?: string[];
            max_concurrency?: number;
            max_parallelism?: number;
            network_use: "normal" | "minimal" | "aggressive" | "custom";
            organization?: string;
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            public: boolean;
            subscription_id?: null | string;
        };
        EndpointOwner: { DATA_TYPE: "endpoint_owner#1.0.0"; identity_id: string };
        EndpointOwner_1_0_0: {
            DATA_TYPE: "endpoint_owner#1.0.0";
            identity_id: string;
        };
        EndpointSubscription: {
            DATA_TYPE: "endpoint_subscription#1.0.0";
            subscription_id: null
            | string;
        };
        EndpointSubscription_1_0_0: {
            DATA_TYPE: "endpoint_subscription#1.0.0";
            subscription_id: null
            | string;
        };
        ExpressionIdentityMapping_1_0_0: {
            DATA_TYPE: "expression_identity_mapping#1.0.0";
            mappings?: {
                ignore_case?: boolean;
                literal?: boolean;
                match?: string;
                output?: string;
                source?: string;
            }[];
        };
        ExternalIdentityMapping_1_0_0: {
            command?: string[];
            DATA_TYPE: "external_identity_mapping#1.0.0";
        };
        Flow: { flow: string };
        FlowAssociation: { transfer?: unknown };
        FlowTransferAssociation: { destination?: unknown; source?: unknown };
        GoogleCloudStorageCollectionPolicies: {
            DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
            project?: string;
        };
        GoogleCloudStorageCollectionPolicies_1_0_0: {
            DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
            project?: string;
        };
        GoogleCloudStoragePolicies: | {
            auth_callback?: string;
            buckets?: null
            | string[];
            client_id: null | string;
            DATA_TYPE: "google_cloud_storage_policies#1.0.0";
            projects?: null | string[];
            secret: null | string;
            service_account_key?: null | Record<string, unknown>;
            user_credential_required?: boolean;
        }
        | {
            allow_any_account?: boolean;
            auth_callback?: string;
            buckets?: null
            | string[];
            client_id: null | string;
            DATA_TYPE: "google_cloud_storage_policies#1.1.0";
            projects?: null | string[];
            secret: null | string;
            service_account_key?: null | Record<string, unknown>;
            user_credential_required?: boolean;
        };
        GoogleCloudStoragePolicies_1_0_0: {
            auth_callback?: string;
            buckets?: null
            | string[];
            client_id: null | string;
            DATA_TYPE: "google_cloud_storage_policies#1.0.0";
            projects?: null | string[];
            secret: null | string;
            service_account_key?: null | Record<string, unknown>;
            user_credential_required?: boolean;
        };
        GoogleCloudStoragePolicies_1_1_0: {
            allow_any_account?: boolean;
            auth_callback?: string;
            buckets?: null
            | string[];
            client_id: null | string;
            DATA_TYPE: "google_cloud_storage_policies#1.1.0";
            projects?: null | string[];
            secret: null | string;
            service_account_key?: null | Record<string, unknown>;
            user_credential_required?: boolean;
        };
        GoogleCloudStorageProject: { name?: string; projectId?: string };
        GoogleCloudStorageUserCredentialPolicies: {
            access_token?: null | string;
            DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
            email?: string;
            projects?: { name?: string; projectId?: string }[];
            refresh_token?: null | string;
            scopes?: string[];
            sub?: string;
            token_expiry?: string;
        };
        GoogleCloudStorageUserCredentialPolicies_1_0_0: {
            access_token?: null
            | string;
            DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
            email?: string;
            projects?: { name?: string; projectId?: string }[];
            refresh_token?: null | string;
            scopes?: string[];
            sub?: string;
            token_expiry?: string;
        };
        GoogleDriveCollectionPolicies: {
            DATA_TYPE: "google_drive_collection_policies#1.0.0";
        };
        GoogleDriveCollectionPolicies_1_0_0: {
            DATA_TYPE: "google_drive_collection_policies#1.0.0";
        };
        GoogleDriveStoragePolicies: | {
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "google_drive_storage_policies#1.0.0";
            secret: null | string;
            user_api_rate_quota?: number;
        }
        | {
            allow_any_account?: boolean;
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "google_drive_storage_policies#1.1.0";
            secret: null | string;
            user_api_rate_quota?: number;
        };
        GoogleDriveStoragePolicies_1_0_0: {
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "google_drive_storage_policies#1.0.0";
            secret: null | string;
            user_api_rate_quota?: number;
        };
        GoogleDriveStoragePolicies_1_1_0: {
            allow_any_account?: boolean;
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "google_drive_storage_policies#1.1.0";
            secret: null | string;
            user_api_rate_quota?: number;
        };
        GoogleDriveUserCredentialPolicies: {
            access_token?: null
            | string;
            DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            token_expiry?: string;
        };
        GoogleDriveUserCredentialPolicies_1_0_0: {
            access_token?: null
            | string;
            DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            token_expiry?: string;
        };
        HPSSCollectionPolicies: { DATA_TYPE: "hpss_collection_policies#1.0.0" };
        HPSSCollectionPolicies_1_0_0: {
            DATA_TYPE: "hpss_collection_policies#1.0.0";
        };
        HPSSStoragePolicies: | {
            authentication_mech: "krb5"
            | "unix";
            authenticator: string;
            DATA_TYPE: "hpss_storage_policies#1.0.0";
            uda_checksum: boolean;
        }
        | {
            authentication_mech: "krb5"
            | "unix";
            authenticator: string;
            DATA_TYPE: "hpss_storage_policies#1.1.0";
            login_name?: string;
            uda_checksum: boolean;
        };
        HPSSStoragePolicies_1_0_0: {
            authentication_mech: "krb5"
            | "unix";
            authenticator: string;
            DATA_TYPE: "hpss_storage_policies#1.0.0";
            uda_checksum: boolean;
        };
        HPSSStoragePolicies_1_1_0: {
            authentication_mech: "krb5"
            | "unix";
            authenticator: string;
            DATA_TYPE: "hpss_storage_policies#1.1.0";
            login_name?: string;
            uda_checksum: boolean;
        };
        HPSSUserCredentialPolicies: {
            DATA_TYPE: "hpss_user_credential_policies#1.0.0";
        };
        HPSSUserCredentialPolicies_1_0_0: {
            DATA_TYPE: "hpss_user_credential_policies#1.0.0";
        };
        IdentityMapping: | {
            command?: string[];
            DATA_TYPE: "external_identity_mapping#1.0.0";
        }
        | {
            DATA_TYPE: "expression_identity_mapping#1.0.0";
            mappings?: {
                ignore_case?: boolean;
                literal?: boolean;
                match?: string;
                output?: string;
                source?: string;
            }[];
        };
        IdNotInIdentitySet: {
            DATA_TYPE: "id_not_in_identity_set#1.0.0";
            id?: string;
        };
        IdNotInIdentitySet_1_0_0: {
            DATA_TYPE: "id_not_in_identity_set#1.0.0";
            id?: string;
        };
        Info: {
            api_version?: string;
            client_id?: string;
            DATA_TYPE: "info#1.0.0";
            domain_name?: string;
            endpoint_id?: string;
            manager_version?: string;
        };
        Info_1_0_0: {
            api_version?: string;
            client_id?: string;
            DATA_TYPE: "info#1.0.0";
            domain_name?: string;
            endpoint_id?: string;
            manager_version?: string;
        };
        InvalidCredential: {
            DATA_TYPE: "invalid_credential#1.0.0";
            user_credential_id: string;
        };
        InvalidCredential_1_0_0: {
            DATA_TYPE: "invalid_credential#1.0.0";
            user_credential_id: string;
        };
        InvalidInput: {
            DATA_TYPE: "invalid_input#1.0.0";
            errors?: { message: string; property?: string }[];
        };
        InvalidInput_1_0_0: {
            DATA_TYPE: "invalid_input#1.0.0";
            errors?: { message: string; property?: string }[];
        };
        InvalidInputItem: { message: string; property?: string };
        InvalidUser: { DATA_TYPE: "invalid_user#1.0.0"; usernames?: string[] };
        InvalidUser_1_0_0: {
            DATA_TYPE: "invalid_user#1.0.0";
            usernames?: string[];
        };
        IrodsCollectionPolicies: { DATA_TYPE: "irods_collection_policies#1.0.0" };
        IrodsCollectionPolicies_1_0_0: {
            DATA_TYPE: "irods_collection_policies#1.0.0";
        };
        IrodsEnvironment: { name: string; value: string };
        IrodsStoragePolicies: {
            DATA_TYPE: "irods_storage_policies#1.0.0";
            environment?: { name: string; value: string }[];
            irods_authentication_file?: string;
            irods_environment_file: string;
        };
        IrodsStoragePolicies_1_0_0: {
            DATA_TYPE: "irods_storage_policies#1.0.0";
            environment?: { name: string; value: string }[];
            irods_authentication_file?: string;
            irods_environment_file: string;
        };
        IrodsUserCredentialPolicies: {
            DATA_TYPE: "irods_user_credential_policies#1.0.0";
        };
        IrodsUserCredentialPolicies_1_0_0: {
            DATA_TYPE: "irods_user_credential_policies#1.0.0";
        };
        LimitExceeded: { DATA_TYPE: "limit_exceeded#1.0.0" };
        LimitExceeded_1_0_0: { DATA_TYPE: "limit_exceeded#1.0.0" };
        MappingExpression: {
            ignore_case?: boolean;
            literal?: boolean;
            match?: string;
            output?: string;
            source?: string;
        };
        MissingRequiredRole: {
            DATA_TYPE: "missing_required_role#1.0.0";
            roles?: {
                collection?: string;
                role: | "owner"
                | "administrator"
                | "access_manager"
                | "activity_manager"
                | "activity_monitor"
                | "access_monitor";
            }[];
        };
        MissingRequiredRole_1_0_0: {
            DATA_TYPE: "missing_required_role#1.0.0";
            roles?: {
                collection?: string;
                role: | "owner"
                | "administrator"
                | "access_manager"
                | "activity_manager"
                | "activity_monitor"
                | "access_monitor";
            }[];
        };
        MissingRequiredScopes: {
            DATA_TYPE: "missing_required_scopes#1.0.0";
            required_scopes?: string[];
        };
        MissingRequiredScopes_1_0_0: {
            DATA_TYPE: "missing_required_scopes#1.0.0";
            required_scopes?: string[];
        };
        MissingRoleEntrySchema: {
            collection?: string;
            role: | "owner"
            | "administrator"
            | "access_manager"
            | "activity_manager"
            | "activity_monitor"
            | "access_monitor";
        };
        Node: | {
            DATA_TYPE: "node#1.0.0";
            id?: string;
            incoming_port_range?: number[];
            ip_addresses: string[];
            outgoing_port_range?: number[];
            status: "active"
            | "inactive";
        }
        | {
            data_interface?: null
            | string;
            DATA_TYPE: "node#1.1.0";
            id?: string;
            incoming_port_range?: number[];
            ip_addresses: string[];
            outgoing_port_range?: number[];
            status: "active" | "inactive";
        }
        | {
            data_interface?: null
            | string;
            data_interface6?: null | string;
            DATA_TYPE: "node#1.2.0";
            id?: string;
            incoming_port_range?: number[];
            ip_addresses: string[];
            outgoing_port_range?: number[];
            status: "active" | "inactive";
        };
        Node_1_0_0: {
            DATA_TYPE: "node#1.0.0";
            id?: string;
            incoming_port_range?: number[];
            ip_addresses: string[];
            outgoing_port_range?: number[];
            status: "active"
            | "inactive";
        };
        Node_1_1_0: {
            data_interface?: null
            | string;
            DATA_TYPE: "node#1.1.0";
            id?: string;
            incoming_port_range?: number[];
            ip_addresses: string[];
            outgoing_port_range?: number[];
            status: "active" | "inactive";
        };
        Node_1_2_0: {
            data_interface?: null
            | string;
            data_interface6?: null | string;
            DATA_TYPE: "node#1.2.0";
            id?: string;
            incoming_port_range?: number[];
            ip_addresses: string[];
            outgoing_port_range?: number[];
            status: "active" | "inactive";
        };
        NotFromAllowedDomain: {
            allowed_domains?: string[];
            DATA_TYPE: "not_from_allowed_domain#1.0.0";
        };
        NotFromAllowedDomain_1_0_0: {
            allowed_domains?: string[];
            DATA_TYPE: "not_from_allowed_domain#1.0.0";
        };
        NotResourceOwner: { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
        NotResourceOwner_1_0_0: {
            DATA_TYPE: "not_resource_owner#1.0.0";
            id?: string;
        };
        OAuthUserCredentialForm: {
            access_token?: string;
            identity_id: string;
            login_hint?: string;
            redirect_uri: string;
            storage_gateway: string;
        };
        OneDriveCollectionPolicies: {
            DATA_TYPE: "onedrive_collection_policies#1.0.0";
        };
        OneDriveCollectionPolicies_1_0_0: {
            DATA_TYPE: "onedrive_collection_policies#1.0.0";
        };
        OneDriveStoragePolicies: | {
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "onedrive_storage_policies#1.0.0";
            secret: null | string;
            tenant?: null | string;
            user_api_rate_limit?: number;
        }
        | {
            allow_any_account?: boolean;
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "onedrive_storage_policies#1.1.0";
            secret: null | string;
            tenant?: null | string;
            user_api_rate_limit?: number;
        };
        OneDriveStoragePolicies_1_0_0: {
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "onedrive_storage_policies#1.0.0";
            secret: null | string;
            tenant?: null | string;
            user_api_rate_limit?: number;
        };
        OneDriveStoragePolicies_1_1_0: {
            allow_any_account?: boolean;
            auth_callback?: string;
            client_id: null
            | string;
            DATA_TYPE: "onedrive_storage_policies#1.1.0";
            secret: null | string;
            tenant?: null | string;
            user_api_rate_limit?: number;
        };
        OneDriveUserCredentialPolicies: {
            access_token?: null
            | string;
            DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            tid?: string;
            token_expiry?: string;
        };
        OneDriveUserCredentialPolicies_1_0_0: {
            access_token?: null
            | string;
            DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
            email?: null | string;
            refresh_token?: null | string;
            scopes?: string[];
            sub?: null | string;
            tid?: string;
            token_expiry?: string;
        };
        OwnerString: { DATA_TYPE: "owner_string#1.0.0"; identity_id?: string };
        OwnerString_1_0_0: {
            DATA_TYPE: "owner_string#1.0.0";
            identity_id?: string;
        };
        PathRestrictions: {
            DATA_TYPE: "path_restrictions#1.0.0";
            none?: string[];
            read?: string[];
            read_write?: string[];
        };
        PathRestrictions_1_0_0: {
            DATA_TYPE: "path_restrictions#1.0.0";
            none?: string[];
            read?: string[];
            read_write?: string[];
        };
        PosixCollectionPolicies: | { DATA_TYPE: "posix_collection_policies#1.0.0" }
        | {
            DATA_TYPE: "posix_collection_policies#1.1.0";
            sharing_groups_allow?: null | string[];
            sharing_groups_deny?: null | string[];
        };
        PosixCollectionPolicies_1_0_0: {
            DATA_TYPE: "posix_collection_policies#1.0.0";
        };
        PosixCollectionPolicies_1_1_0: {
            DATA_TYPE: "posix_collection_policies#1.1.0";
            sharing_groups_allow?: null
            | string[];
            sharing_groups_deny?: null | string[];
        };
        PosixStagingCollectionPolicies: {
            DATA_TYPE: "posix_staging_collection_policies#1.0.0";
            sharing_groups_allow?: null
            | string[];
            sharing_groups_deny?: null | string[];
        };
        PosixStagingCollectionPolicies_1_0_0: {
            DATA_TYPE: "posix_staging_collection_policies#1.0.0";
            sharing_groups_allow?: null
            | string[];
            sharing_groups_deny?: null | string[];
        };
        PosixStagingEnvironment: { name: string; value: string };
        PosixStagingStoragePolicies: {
            DATA_TYPE: "posix_staging_storage_policies#1.0.0";
            environment?: { name: string; value: string }[];
            groups_allow?: null | string[];
            groups_deny?: null | string[];
            stage_app: string;
        };
        PosixStagingStoragePolicies_1_0_0: {
            DATA_TYPE: "posix_staging_storage_policies#1.0.0";
            environment?: { name: string; value: string }[];
            groups_allow?: null | string[];
            groups_deny?: null | string[];
            stage_app: string;
        };
        PosixStagingUserCredentialPolicies: {
            DATA_TYPE: "posix_staging_user_credential_policies#1.0.0";
        };
        PosixStagingUserCredentialPolicies_1_0_0: {
            DATA_TYPE: "posix_staging_user_credential_policies#1.0.0";
        };
        PosixStoragePolicies: {
            DATA_TYPE: "posix_storage_policies#1.0.0";
            groups_allow?: null
            | string[];
            groups_deny?: null | string[];
        };
        PosixStoragePolicies_1_0_0: {
            DATA_TYPE: "posix_storage_policies#1.0.0";
            groups_allow?: null
            | string[];
            groups_deny?: null | string[];
        };
        PosixUserCredentialPolicies: {
            DATA_TYPE: "posix_user_credential_policies#1.0.0";
        };
        PosixUserCredentialPolicies_1_0_0: {
            DATA_TYPE: "posix_user_credential_policies#1.0.0";
        };
        ResourceConflict: {
            DATA_TYPE: "resource_conflict#1.0.0";
            resources?: string[];
        };
        ResourceConflict_1_0_0: {
            DATA_TYPE: "resource_conflict#1.0.0";
            resources?: string[];
        };
        Result: | {
            code: string;
            data?: Record<string, unknown>[];
            DATA_TYPE: "result#1.0.0";
            detail?: unknown;
            has_next_page: boolean;
            http_response_code: number;
            marker?: null | string;
            message?: string;
        }
        | {
            authorization_parameters?: null
            | { [key: string]: unknown };
            code: string;
            data?: Record<string, unknown>[];
            DATA_TYPE: "result#1.1.0";
            detail?: unknown;
            has_next_page: boolean;
            http_response_code: number;
            marker?: null | string;
            message?: string;
        };
        Result_1_0_0: {
            code: string;
            data?: Record<string, unknown>[];
            DATA_TYPE: "result#1.0.0";
            detail?: unknown;
            has_next_page: boolean;
            http_response_code: number;
            marker?: null | string;
            message?: string;
        };
        Result_1_1_0: {
            authorization_parameters?: null
            | { [key: string]: unknown };
            code: string;
            data?: Record<string, unknown>[];
            DATA_TYPE: "result#1.1.0";
            detail?: unknown;
            has_next_page: boolean;
            http_response_code: number;
            marker?: null | string;
            message?: string;
        };
        Role: {
            collection?: null
            | string;
            DATA_TYPE: "role#1.0.0";
            id?: string;
            principal: string;
            role:
                | "owner"
                | "administrator"
                | "access_manager"
                | "activity_manager"
                | "activity_monitor"
                | "access_monitor";
        };
        Role_1_0_0: {
            collection?: null
            | string;
            DATA_TYPE: "role#1.0.0";
            id?: string;
            principal: string;
            role:
                | "owner"
                | "administrator"
                | "access_manager"
                | "activity_manager"
                | "activity_monitor"
                | "access_monitor";
        };
        S3CollectionPolicies: { DATA_TYPE: "s3_collection_policies#1.0.0" };
        S3CollectionPolicies_1_0_0: { DATA_TYPE: "s3_collection_policies#1.0.0" };
        S3KeysPrefixPaths_1_0_0: {
            path_prefixes: string[];
            s3_key_id?: null | string;
            s3_secret_key?: null | string;
        };
        S3StoragePolicies: | {
            DATA_TYPE: "s3_storage_policies#1.0.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_user_credential_required?: boolean;
        }
        | {
            DATA_TYPE: "s3_storage_policies#1.1.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_requester_pays?: boolean;
            s3_user_credential_required?: boolean;
        }
        | {
            DATA_TYPE: "s3_storage_policies#1.2.0";
            s3_allow_multi_keys?: boolean;
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_requester_pays?: boolean;
            s3_user_credential_required?: boolean;
        };
        S3StoragePolicies_1_0_0: {
            DATA_TYPE: "s3_storage_policies#1.0.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_user_credential_required?: boolean;
        };
        S3StoragePolicies_1_1_0: {
            DATA_TYPE: "s3_storage_policies#1.1.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_requester_pays?: boolean;
            s3_user_credential_required?: boolean;
        };
        S3StoragePolicies_1_2_0: {
            DATA_TYPE: "s3_storage_policies#1.2.0";
            s3_allow_multi_keys?: boolean;
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_requester_pays?: boolean;
            s3_user_credential_required?: boolean;
        };
        S3UserCredentialPolicies: | {
            DATA_TYPE: "s3_user_credential_policies#1.0.0";
            s3_key_id?: null
            | string;
            s3_secret_key?: null | string;
        }
        | {
            DATA_TYPE: "s3_user_credential_policies#1.1.0";
            s3_key_id?: null
            | string;
            s3_requester_pays?: boolean;
            s3_secret_key?: null | string;
        }
        | {
            DATA_TYPE: "s3_user_credential_policies#1.2.0";
            s3_key_id?: null
            | string;
            s3_multi_keys?:
                | null
                | {
                    path_prefixes: string[];
                    s3_key_id?: null
                    | string;
                    s3_secret_key?: null | string;
                }[];
            s3_requester_pays?: boolean;
            s3_secret_key?: null
            | string;
        };
        S3UserCredentialPolicies_1_0_0: {
            DATA_TYPE: "s3_user_credential_policies#1.0.0";
            s3_key_id?: null
            | string;
            s3_secret_key?: null | string;
        };
        S3UserCredentialPolicies_1_1_0: {
            DATA_TYPE: "s3_user_credential_policies#1.1.0";
            s3_key_id?: null
            | string;
            s3_requester_pays?: boolean;
            s3_secret_key?: null | string;
        };
        S3UserCredentialPolicies_1_2_0: {
            DATA_TYPE: "s3_user_credential_policies#1.2.0";
            s3_key_id?: null
            | string;
            s3_multi_keys?:
                | null
                | {
                    path_prefixes: string[];
                    s3_key_id?: null
                    | string;
                    s3_secret_key?: null | string;
                }[];
            s3_requester_pays?: boolean;
            s3_secret_key?: null
            | string;
        };
        SharingPolicy: {
            collection_id: string;
            DATA_TYPE: "sharing_policy#1.0.0";
            id?: string;
            sharing_restrict_paths: {
                DATA_TYPE: "path_restrictions#1.0.0";
                none?: string[];
                read?: string[];
                read_write?: string[];
            };
            users?: string[];
        };
        SharingPolicy_1_0_0: {
            collection_id: string;
            DATA_TYPE: "sharing_policy#1.0.0";
            id?: string;
            sharing_restrict_paths: {
                DATA_TYPE: "path_restrictions#1.0.0";
                none?: string[];
                read?: string[];
                read_write?: string[];
            };
            users?: string[];
        };
        StorageGateway: | {
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.0.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: (...)
                            | (...)
                            | (...);
                            literal?: (...) | (...) | (...);
                            match?: (...) | (...);
                            output?: (...) | (...);
                            source?: (...) | (...);
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        }
        | {
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.1.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: (...)
                            | (...)
                            | (...);
                            literal?: (...) | (...) | (...);
                            match?: (...) | (...);
                            output?: (...) | (...);
                            source?: (...) | (...);
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        }
        | {
            admin_managed_credentials: boolean;
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.2.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: (...)
                            | (...)
                            | (...);
                            literal?: (...) | (...) | (...);
                            match?: (...) | (...);
                            output?: (...) | (...);
                            source?: (...) | (...);
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        }
        | {
            admin_managed_credentials: boolean;
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.3.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: (...)
                            | (...)
                            | (...);
                            literal?: (...) | (...) | (...);
                            match?: (...) | (...);
                            output?: (...) | (...);
                            source?: (...) | (...);
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            max_concurrency?: number;
            max_parallelism?: number;
            network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        };
        StorageGateway_1_0_0: {
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.0.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        };
        StorageGateway_1_1_0: {
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.1.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        };
        StorageGateway_1_2_0: {
            admin_managed_credentials: boolean;
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.2.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        };
        StorageGateway_1_3_0: {
            admin_managed_credentials: boolean;
            allowed_domains?: string[];
            authentication_assurance_timeout?: null
            | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.3.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | {
                        command?: string[];
                        DATA_TYPE: "external_identity_mapping#1.0.0";
                    }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            max_concurrency?: number;
            max_parallelism?: number;
            network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        };
        StorageGatewayNotFound: {
            DATA_TYPE: "storage_gateway_not_found#1.0.0";
            storage_gateway_id?: string;
        };
        StorageGatewayNotFound_1_0_0: {
            DATA_TYPE: "storage_gateway_not_found#1.0.0";
            storage_gateway_id?: string;
        };
        SubscriptionAdminVerified: {
            DATA_TYPE: "subscription_admin_verified#1.0.0";
            subscription_admin_verified: boolean;
        };
        SubscriptionAdminVerified_1_0_0: {
            DATA_TYPE: "subscription_admin_verified#1.0.0";
            subscription_admin_verified: boolean;
        };
        SubscriptionRequired: {
            add_ons?: string[];
            DATA_TYPE: "subscription_required#1.0.0";
            subscription_level?: string;
        };
        SubscriptionRequired_1_0_0: {
            add_ons?: string[];
            DATA_TYPE: "subscription_required#1.0.0";
            subscription_level?: string;
        };
        UserCredential: {
            connector_id?: string;
            DATA_TYPE: "user_credential#1.0.0";
            deleted?: boolean;
            display_name?: null
            | string;
            home_directory?: string;
            id?: string;
            identity_id?: string;
            invalid?: boolean;
            policies?:
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.0.0";
                    s3_key_id?: null
                    | string;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.1.0";
                    s3_key_id?: null
                    | string;
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.2.0";
                    s3_key_id?: null
                    | string;
                    s3_multi_keys?:
                        | null
                        | {
                            path_prefixes: string[];
                            s3_key_id?: null
                            | string;
                            s3_secret_key?: null | string;
                        }[];
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null
                    | string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | {
                    access_id?: string;
                    DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                    secret_key?: string;
                }
                | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "box_user_credential_policies#1.1.0";
                    email?: null | string;
                    max_upload?: number;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    root_info?: Record<string, unknown>;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                    email?: string;
                    projects?: { name?: string; projectId?: string }[];
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
            provisioned?: boolean;
            storage_gateway_id?: string;
            username?: string;
        };
        UserCredential_1_0_0: {
            connector_id?: string;
            DATA_TYPE: "user_credential#1.0.0";
            deleted?: boolean;
            display_name?: null
            | string;
            home_directory?: string;
            id?: string;
            identity_id?: string;
            invalid?: boolean;
            policies?:
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.0.0";
                    s3_key_id?: null
                    | string;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.1.0";
                    s3_key_id?: null
                    | string;
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.2.0";
                    s3_key_id?: null
                    | string;
                    s3_multi_keys?:
                        | null
                        | {
                            path_prefixes: string[];
                            s3_key_id?: null
                            | string;
                            s3_secret_key?: null | string;
                        }[];
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null
                    | string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | {
                    access_id?: string;
                    DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                    secret_key?: string;
                }
                | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "box_user_credential_policies#1.1.0";
                    email?: null | string;
                    max_upload?: number;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    root_info?: Record<string, unknown>;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                    email?: string;
                    projects?: { name?: string; projectId?: string }[];
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
            provisioned?: boolean;
            storage_gateway_id?: string;
            username?: string;
        };
    }

    Type declaration

    • Account: {
          DATA_TYPE: "account#1.0.0";
          identity_id?: string;
          storage_gateway_id?: string;
          username?: string;
      }

      Account

      User account information for a particular Storage Gateway.

      • DATA_TYPE: "account#1.0.0"

        Type of this document

        account#1.0.0
        @enum {string}
      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity which maps to this account

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Storage Gateway for which this account is valid.

      • Optionalusername?: string

        Connector-specific local username

    • Account_1_0_0: {
          DATA_TYPE: "account#1.0.0";
          identity_id?: string;
          storage_gateway_id?: string;
          username?: string;
      }

      Account_1_0_0

      User account information for a particular Storage Gateway.

      • DATA_TYPE: "account#1.0.0"

        Type of this document

        account#1.0.0
        @enum {string}
      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity which maps to this account

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Storage Gateway for which this account is valid.

      • Optionalusername?: string

        Connector-specific local username

    • ActiveScaleCollectionPolicies: { DATA_TYPE: "s3_collection_policies#1.0.0" }

      ActiveScaleCollectionPolicies

      Connector-specific storage gateway policies for the ActiveScale connector. These are identical to s3 connector's storage gateway policies.

      • DATA_TYPE: "s3_collection_policies#1.0.0"

        Type of this document

        s3_collection_policies#1.0.0
        @enum {string}
    • ActiveScaleStoragePolicies: {
          DATA_TYPE: "s3_storage_policies#1.0.0";
          s3_buckets?: string[];
          s3_endpoint?: string;
          s3_user_credential_required?: boolean;
      }

      ActiveScaleStoragePolicies

      Connector-specific storage gateway policies for the ActiveScale connector. These are identical to s3 connector's storage gateway policies.

      • DATA_TYPE: "s3_storage_policies#1.0.0"

        Type of this document

        s3_storage_policies#1.0.0
        @enum {string}
      • Optionals3_buckets?: string[]

        List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this storage gateway.

      • Optionals3_endpoint?: string

        URL of the S3 API endpoint

        https://s3.amazonaws.com
        
      • Optionals3_user_credential_required?: boolean

        Flag indicating if a Globus User must register a user credential in order to create a guest collection on this storage gateway.

    • ActiveScaleUserCredentialPolicies: {
          DATA_TYPE: "s3_user_credential_policies#1.0.0";
          s3_key_id?: null | string;
          s3_secret_key?: null | string;
      }

      ActiveScaleUserCredentialPolicies

      Connector-specific storage gateway policies for the ActiveScale connector. These are identical to s3 connector's storage gateway policies.

      • DATA_TYPE: "s3_user_credential_policies#1.0.0"

        Type of this document

        s3_user_credential_policies#1.0.0
        @enum {string}
      • Optionals3_key_id?: null | string

        Access Key ID to use with the S3 API to access your buckets and objects.

      • Optionals3_secret_key?: null | string

        Secret key to use with the S3 API to access your buckets and objects.

    • ActivityNotificationPolicy: { status: string[]; transfer_use: string[] }

      ActivityNotificationPolicy

    • AuthenticationTimeout:
          | {
              DATA_TYPE: "authentication_timeout#1.0.0";
              high_assurance?: boolean;
              identities?: string[];
          }
          | {
              DATA_TYPE: "authentication_timeout#1.1.0";
              high_assurance?: boolean;
              identities?: string[];
              require_mfa?: boolean;
          }

      AuthenticationTimeout

      Error details when a user must reauthenticate an identity in order to perform this operation.

      Version 1.1.0 adds the require_mfa property.
      
    • AuthenticationTimeout_1_0_0: {
          DATA_TYPE: "authentication_timeout#1.0.0";
          high_assurance?: boolean;
          identities?: string[];
      }

      AuthenticationTimeout_1_0_0

      Error details when a user must reauthenticate an identity in order to perform this operation.

      • DATA_TYPE: "authentication_timeout#1.0.0"

        Type of this document

        authentication_timeout#1.0.0
        @enum {string}
      • Optionalhigh_assurance?: boolean

        Boolean flag indicating whether the new authentication must be done within the same auth session as the application making the request.

      • Optionalidentities?: string[]

        List of identities that would have otherwise been authorized except that the authentication has timed out.

    • AuthenticationTimeout_1_1_0: {
          DATA_TYPE: "authentication_timeout#1.1.0";
          high_assurance?: boolean;
          identities?: string[];
          require_mfa?: boolean;
      }

      AuthenticationTimeout_1_1_0

      Error details when a user must reauthenticate an identity in order to perform this operation.

      Version 1.1.0 adds the require_mfa property.
      
      • DATA_TYPE: "authentication_timeout#1.1.0"

        Type of this document

        authentication_timeout#1.1.0
        @enum {string}
      • Optionalhigh_assurance?: boolean

        Boolean flag indicating whether the new authentication must be done within the same auth session as the application making the request.

      • Optionalidentities?: string[]

        List of identities that would have otherwise been authorized except that the authentication has timed out.

      • Optionalrequire_mfa?: boolean

        Flag indicating that multi-factor authentication is required. Only occurs on high assurance storage gateways.

    • AzureBlobCollectionPolicies: { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }

      AzureBlobCollectionPolicies

      Connector-specific collection policies for the AzureBlob connector

      • DATA_TYPE: "azure_blob_collection_policies#1.0.0"

        Type of this document

        azure_blob_collection_policies#1.0.0
        @enum {string}
    • AzureBlobCollectionPolicies_1_0_0: { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }

      AzureBlobCollectionPolicies_1_0_0

      Connector-specific collection policies for the AzureBlob connector

      • DATA_TYPE: "azure_blob_collection_policies#1.0.0"

        Type of this document

        azure_blob_collection_policies#1.0.0
        @enum {string}
    • AzureBlobStoragePolicies:
          | {
              account: null
              | string;
              adls: null | boolean;
              auth_callback?: string;
              auth_type: null | string;
              client_id: null | string;
              DATA_TYPE: "azure_blob_storage_policies#1.0.0";
              secret: null | string;
              tenant: null | string;
              user_credential_required?: boolean;
          }
          | {
              account: null
              | string;
              adls: null | boolean;
              allow_any_account?: boolean;
              auth_callback?: string;
              auth_type: null | string;
              client_id: null | string;
              DATA_TYPE: "azure_blob_storage_policies#1.1.0";
              secret: null | string;
              tenant: null | string;
              user_credential_required?: boolean;
          }

      AzureBlobStoragePolicies

      Connector-specific storage gateway policies for the AzureBlob connector

    • AzureBlobStoragePolicies_1_0_0: {
          account: null | string;
          adls: null | boolean;
          auth_callback?: string;
          auth_type: null | string;
          client_id: null | string;
          DATA_TYPE: "azure_blob_storage_policies#1.0.0";
          secret: null | string;
          tenant: null | string;
          user_credential_required?: boolean;
      }

      AzureBlobStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the AzureBlob connector

      • account: null | string

        Azure Storage account to access with this storage gateway

      • adls: null | boolean

        Flag indicating the Azure storage account has enabled Azure Data Lake Gen2 hierarchical namespace support.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Microsoft API console for the application client_id in order to process Microsoft credentials.

      • auth_type: null | string

        The method of authentication to Azure. "user" prompts the user to log in to their Microsoft account via an oauth2 flow. "service_principal" uses the configured client_id and client_secret values to authenticate as an Azure service principal.

      • client_id: null | string

        Client ID registered with the Azure console to access Azure Blob.

      • DATA_TYPE: "azure_blob_storage_policies#1.0.0"

        Type of this document

        azure_blob_storage_policies#1.0.0
        @enum {string}
      • secret: null | string

        Secret created in the Azure console to access Azure Blob with the client_id in this policy.

      • tenant: null | string

        Tenant id of the Microsoft organization

      • Optional Readonlyuser_credential_required?: boolean

        Flag indicating whether users must register a credential. If true (or if this property is missing), this storage gateway is configured for OAuth2 user authentication. If false, authentication is configured by the admin.

    • AzureBlobStoragePolicies_1_1_0: {
          account: null | string;
          adls: null | boolean;
          allow_any_account?: boolean;
          auth_callback?: string;
          auth_type: null | string;
          client_id: null | string;
          DATA_TYPE: "azure_blob_storage_policies#1.1.0";
          secret: null | string;
          tenant: null | string;
          user_credential_required?: boolean;
      }

      AzureBlobStoragePolicies_1_1_0

      Connector-specific storage gateway policies for the AzureBlob connector

      • account: null | string

        Azure Storage account to access with this storage gateway

      • adls: null | boolean

        Flag indicating the Azure storage account has enabled Azure Data Lake Gen2 hierarchical namespace support.

      • Optionalallow_any_account?: boolean

        If true, allow users to access personal or external Microsoft accounts. If false (the default), users must use the Microsoft account which matches the username their Globus credential maps to.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Microsoft API console for the application client_id in order to process Microsoft credentials.

      • auth_type: null | string

        The method of authentication to Azure. "user" prompts the user to log in to their Microsoft account via an oauth2 flow. "service_principal" uses the configured client_id and client_secret values to authenticate as an Azure service principal.

      • client_id: null | string

        Client ID registered with the Azure console to access Azure Blob.

      • DATA_TYPE: "azure_blob_storage_policies#1.1.0"

        Type of this document

        azure_blob_storage_policies#1.1.0
        @enum {string}
      • secret: null | string

        Secret created in the Azure console to access Azure Blob with the client_id in this policy.

      • tenant: null | string

        Tenant id of the Microsoft organization

      • Optional Readonlyuser_credential_required?: boolean

        Flag indicating whether users must register a credential. If true (or if this property is missing), this storage gateway is configured for OAuth2 user authentication. If false, authentication is configured by the admin.

    • AzureBlobUserCredentialPolicies: {
          access_token?: null | string;
          DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          scopes?: string[];
          sub?: null | string;
          tid?: string;
          token_expiry?: string;
      }

      AzureBlobUserCredentialPolicies

      Connector-specific user credential policies for the AzureBlob connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "azure_blob_user_credential_policies#1.0.0"

        Type of this document

        azure_blob_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh_token token

      • Optionalscopes?: string[]

        OAuth scopes associated with this access token

      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltid?: string

        Tenant id

      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • AzureBlobUserCredentialPolicies_1_0_0: {
          access_token?: null | string;
          DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          scopes?: string[];
          sub?: null | string;
          tid?: string;
          token_expiry?: string;
      }

      AzureBlobUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the AzureBlob connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "azure_blob_user_credential_policies#1.0.0"

        Type of this document

        azure_blob_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh_token token

      • Optionalscopes?: string[]

        OAuth scopes associated with this access token

      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltid?: string

        Tenant id

      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • Batch: { DATA_TYPE: "batch#1.0.0"; ids?: string[] }

      Batch

      The Batch data type is used to specify multiple objects to operate on via a single REST API call.

      • DATA_TYPE: "batch#1.0.0"

        Type of this document

        batch#1.0.0
        @enum {string}
      • Optionalids?: string[]

        List of object IDs to operate on

    • Batch_1_0_0: { DATA_TYPE: "batch#1.0.0"; ids?: string[] }

      Batch_1_0_0

      The Batch data type is used to specify multiple objects to operate on via a single REST API call.

      • DATA_TYPE: "batch#1.0.0"

        Type of this document

        batch#1.0.0
        @enum {string}
      • Optionalids?: string[]

        List of object IDs to operate on

    • BlackPearlCollectionPolicies: { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }

      BlackPearlCollectionPolicies

      Connector-specific collection policies for the BlackPearl connector

      • DATA_TYPE: "blackpearl_collection_policies#1.0.0"

        Type of this document

        blackpearl_collection_policies#1.0.0
        @enum {string}
    • BlackPearlCollectionPolicies_1_0_0: { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }

      BlackPearlCollectionPolicies_1_0_0

      Connector-specific collection policies for the BlackPearl connector

      • DATA_TYPE: "blackpearl_collection_policies#1.0.0"

        Type of this document

        blackpearl_collection_policies#1.0.0
        @enum {string}
    • BlackPearlStoragePolicies: {
          bp_access_id_file?: string;
          DATA_TYPE: "blackpearl_storage_policies#1.0.0";
          s3_endpoint?: string;
      }

      BlackPearlStoragePolicies

      Connector-specific storage gateway policies for the Blackpearl connector

      • Optionalbp_access_id_file?: string

        Path to the file which provides mappings from usernames within the configured identity domain to the ID and secret associated with the user's BlackPearl account

      • DATA_TYPE: "blackpearl_storage_policies#1.0.0"

        Type of this document

        blackpearl_storage_policies#1.0.0
        @enum {string}
      • Optionals3_endpoint?: string

        The URL of the S3 endpoint of the BlackPearl appliance to use to access collections on this Storage Gateway.

    • BlackPearlStoragePolicies_1_0_0: {
          bp_access_id_file?: string;
          DATA_TYPE: "blackpearl_storage_policies#1.0.0";
          s3_endpoint?: string;
      }

      BlackPearlStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the Blackpearl connector

      • Optionalbp_access_id_file?: string

        Path to the file which provides mappings from usernames within the configured identity domain to the ID and secret associated with the user's BlackPearl account

      • DATA_TYPE: "blackpearl_storage_policies#1.0.0"

        Type of this document

        blackpearl_storage_policies#1.0.0
        @enum {string}
      • Optionals3_endpoint?: string

        The URL of the S3 endpoint of the BlackPearl appliance to use to access collections on this Storage Gateway.

    • BlackPearlUserCredentialPolicies: {
          access_id?: string;
          DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
          secret_key?: string;
      }

      BlackPearlUserCredentialPolicies

      Connector-specific user credential policies for the Blackpearl connector

      • Optional Readonlyaccess_id?: string

        BlackPearl access id

      • DATA_TYPE: "blackpearl_user_credential_policies#1.0.0"

        Type of this document

        blackpearl_user_credential_policies#1.0.0
        @enum {string}
      • Optional Readonlysecret_key?: string

        BlackPearl secret key

    • BlackPearlUserCredentialPolicies_1_0_0: {
          access_id?: string;
          DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
          secret_key?: string;
      }

      BlackPearlUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the Blackpearl connector

      • Optional Readonlyaccess_id?: string

        BlackPearl access id

      • DATA_TYPE: "blackpearl_user_credential_policies#1.0.0"

        Type of this document

        blackpearl_user_credential_policies#1.0.0
        @enum {string}
      • Optional Readonlysecret_key?: string

        BlackPearl secret key

    • BoxAppAuth: { passphrase: string; privateKey: string; publicKeyID: string }

      BoxAppAuth

      Key information used to perform JWT grants for using the Box API

      • passphrase: string

        Passphrase to decrypt the private key

      • privateKey: string

        Private key

      • publicKeyID: string

        ID of the public key

    • BoxAppSettings: {
          appAuth: { passphrase: string; privateKey: string; publicKeyID: string };
          clientID: string;
          clientSecret: string;
      }

      BoxAppSettings

      Values from the Box JWT client configuration that the storage gateway uses to identify and authenticate with the Box API. This is only set when configuring the storage gateway for Box enterprise authentication.

      • appAuth: { passphrase: string; privateKey: string; publicKeyID: string }

        Box application keys

        • passphrase: string

          Passphrase to decrypt the private key

        • privateKey: string

          Private key

        • publicKeyID: string

          ID of the public key

      • clientID: string

        Application client ID

      • clientSecret: string

        Application client secret

    • BoxCollectionPolicies: { DATA_TYPE: "box_collection_policies#1.0.0" }

      BoxCollectionPolicies

      Connector-specific collection policies for the Box connector

      • DATA_TYPE: "box_collection_policies#1.0.0"

        Type of this document

        box_collection_policies#1.0.0
        @enum {string}
    • BoxCollectionPolicies_1_0_0: { DATA_TYPE: "box_collection_policies#1.0.0" }

      BoxCollectionPolicies_1_0_0

      Connector-specific collection policies for the Box connector

      • DATA_TYPE: "box_collection_policies#1.0.0"

        Type of this document

        box_collection_policies#1.0.0
        @enum {string}
    • BoxStorage_1_0_0: {
          boxAppSettings: {
              appAuth: {
                  passphrase: string;
                  privateKey: string;
                  publicKeyID: string;
              };
              clientID: string;
              clientSecret: string;
          };
          DATA_TYPE: "box_storage_policies#1.0.0";
          enterpriseID: string;
      }

      BoxStorage_1_0_0

      Connector-specific storage gateway policies for the Box connector.

      • boxAppSettings: {
            appAuth: { passphrase: string; privateKey: string; publicKeyID: string };
            clientID: string;
            clientSecret: string;
        }

        Box Application settings

        • appAuth: { passphrase: string; privateKey: string; publicKeyID: string }

          Box application keys

          • passphrase: string

            Passphrase to decrypt the private key

          • privateKey: string

            Private key

          • publicKeyID: string

            ID of the public key

        • clientID: string

          Application client ID

        • clientSecret: string

          Application client secret

      • DATA_TYPE: "box_storage_policies#1.0.0"

        Type of this document

        box_storage_policies#1.0.0
        @enum {string}
      • enterpriseID: string

        Identifies which Box Enterprise this storage gateway is authorized access to. This is only set when configuring the storage gateway for Box enterprise authentication.

    • BoxStorage_1_1_0: {
          auth_callback?: string;
          boxAppSettings?: {
              appAuth: {
                  passphrase: string;
                  privateKey: string;
                  publicKeyID: string;
              };
              clientID: string;
              clientSecret: string;
          };
          client_id?: string;
          DATA_TYPE: "box_storage_policies#1.1.0";
          enterpriseID?: string;
          secret?: string;
          user_api_rate_limit?: number;
          user_credential_required?: boolean;
      }

      BoxStorage_1_1_0

      Connector-specific storage gateway policies for the Box connector.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be set on the Box developer console for the Box application of client_id.

      • OptionalboxAppSettings?: {
            appAuth: { passphrase: string; privateKey: string; publicKeyID: string };
            clientID: string;
            clientSecret: string;
        }
        • appAuth: { passphrase: string; privateKey: string; publicKeyID: string }

          Box application keys

          • passphrase: string

            Passphrase to decrypt the private key

          • privateKey: string

            Private key

          • publicKeyID: string

            ID of the public key

        • clientID: string

          Application client ID

        • clientSecret: string

          Application client secret

      • Optionalclient_id?: string

        Client ID of the Box OAuth2 application registered on the Box developer console. This is only set when configuring the storage gateway for OAuth2 user authentication.

      • DATA_TYPE: "box_storage_policies#1.1.0"

        Type of this document

        box_storage_policies#1.1.0
        @enum {string}
      • OptionalenterpriseID?: string

        Identifies which Box Enterprise this storage gateway is authorized access to. This is only set when configuring the storage gateway for Box enterprise authentication.

      • Optionalsecret?: string

        Secret associated with the client_id set in this policy. This is only set when configuring the storage gateway for OAuth2 user authentication.

      • Optionaluser_api_rate_limit?: number

        User API Rate Limit associated with this client ID in operations per second per user.

      • Optional Readonlyuser_credential_required?: boolean

        Flag indicating whether users must register a credential. If true, this storage gateway is configured for OAuth2 user authentication. If false (and for older DATA_TYPE where this property is missing), this storage gateway is configured for enterprise authentication.

    • BoxStorage_1_2_0: {
          allow_any_account?: boolean;
          auth_callback?: string;
          boxAppSettings?: {
              appAuth: {
                  passphrase: string;
                  privateKey: string;
                  publicKeyID: string;
              };
              clientID: string;
              clientSecret: string;
          };
          client_id?: string;
          DATA_TYPE: "box_storage_policies#1.2.0";
          enterpriseID?: string;
          secret?: string;
          user_api_rate_limit?: number;
          user_credential_required?: boolean;
      }

      BoxStorage_1_2_0

      Connector-specific storage gateway policies for the Box connector.

      • Optionalallow_any_account?: boolean

        If true, allow users to access personal or external Box accounts. If false (the default), users must use the Box account which matches the username their Globus credential maps to.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be set on the Box developer console for the Box application of client_id.

      • OptionalboxAppSettings?: {
            appAuth: { passphrase: string; privateKey: string; publicKeyID: string };
            clientID: string;
            clientSecret: string;
        }
        • appAuth: { passphrase: string; privateKey: string; publicKeyID: string }

          Box application keys

          • passphrase: string

            Passphrase to decrypt the private key

          • privateKey: string

            Private key

          • publicKeyID: string

            ID of the public key

        • clientID: string

          Application client ID

        • clientSecret: string

          Application client secret

      • Optionalclient_id?: string

        Client ID of the Box OAuth2 application registered on the Box developer console. This is only set when configuring the storage gateway for OAuth2 user authentication.

      • DATA_TYPE: "box_storage_policies#1.2.0"

        Type of this document

        box_storage_policies#1.2.0
        @enum {string}
      • OptionalenterpriseID?: string

        Identifies which Box Enterprise this storage gateway is authorized access to. This is only set when configuring the storage gateway for Box enterprise authentication.

      • Optionalsecret?: string

        Secret associated with the client_id set in this policy. This is only set when configuring the storage gateway for OAuth2 user authentication.

      • Optionaluser_api_rate_limit?: number

        User API Rate Limit associated with this client ID in operations per second per user.

      • Optional Readonlyuser_credential_required?: boolean

        Flag indicating whether users must register a credential. If true, this storage gateway is configured for OAuth2 user authentication. If false (and for older DATA_TYPE where this property is missing), this storage gateway is configured for enterprise authentication.

    • BoxStoragePolicies:
          | {
              boxAppSettings: {
                  appAuth: {
                      passphrase: string;
                      privateKey: string;
                      publicKeyID: string;
                  };
                  clientID: string;
                  clientSecret: string;
              };
              DATA_TYPE: "box_storage_policies#1.0.0";
              enterpriseID: string;
          }
          | {
              auth_callback?: string;
              boxAppSettings?: {
                  appAuth: {
                      passphrase: string;
                      privateKey: string;
                      publicKeyID: string;
                  };
                  clientID: string;
                  clientSecret: string;
              };
              client_id?: string;
              DATA_TYPE: "box_storage_policies#1.1.0";
              enterpriseID?: string;
              secret?: string;
              user_api_rate_limit?: number;
              user_credential_required?: boolean;
          }
          | {
              allow_any_account?: boolean;
              auth_callback?: string;
              boxAppSettings?: {
                  appAuth: {
                      passphrase: string;
                      privateKey: string;
                      publicKeyID: string;
                  };
                  clientID: string;
                  clientSecret: string;
              };
              client_id?: string;
              DATA_TYPE: "box_storage_policies#1.2.0";
              enterpriseID?: string;
              secret?: string;
              user_api_rate_limit?: number;
              user_credential_required?: boolean;
          }

      BoxStoragePolicies

      Connector-specific storage gateway policies for the Box connector.

    • BoxUserCredential_1_0_0: { DATA_TYPE: "box_user_credential_policies#1.0.0" }

      BoxUserCredential_1_0_0

      Connector-specific user credential policies for the Box connector

      • DATA_TYPE: "box_user_credential_policies#1.0.0"

        Type of this document

        box_user_credential_policies#1.0.0
        @enum {string}
    • BoxUserCredential_1_1_0: {
          access_token?: null | string;
          DATA_TYPE: "box_user_credential_policies#1.1.0";
          email?: null | string;
          max_upload?: number;
          refresh_token?: null | string;
          scopes?: string[];
          sub?: null | string;
          token_expiry?: string;
      }

      BoxUserCredential_1_1_0

      Connector-specific user credential policies for the Box connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "box_user_credential_policies#1.1.0"

        Type of this document

        box_user_credential_policies#1.1.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email identifier claim

      • Optionalmax_upload?: number
      • Optionalrefresh_token?: null | string

        OAuth refresh token

      • Optionalscopes?: string[]

        OAuth scopes associated with this access token

        [
        "box_readwrite"
        ]
      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • BoxUserCredentialPolicies:
          | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
          | {
              access_token?: null | string;
              DATA_TYPE: "box_user_credential_policies#1.1.0";
              email?: null | string;
              max_upload?: number;
              refresh_token?: null | string;
              scopes?: string[];
              sub?: null | string;
              token_expiry?: string;
          }

      BoxUserCredentialPolicies

      Connector-specific user credential policies for the Box connector

    • CephCollectionPolicies: { DATA_TYPE: "ceph_collection_policies#1.0.0" }

      CephCollectionPolicies

      Connector-specific collection policies for the Ceph connector

      • DATA_TYPE: "ceph_collection_policies#1.0.0"

        Type of this document

        ceph_collection_policies#1.0.0
        @enum {string}
    • CephCollectionPolicies_1_0_0: { DATA_TYPE: "ceph_collection_policies#1.0.0" }

      CephCollectionPolicies_1_0_0

      Connector-specific collection policies for the Ceph connector

      • DATA_TYPE: "ceph_collection_policies#1.0.0"

        Type of this document

        ceph_collection_policies#1.0.0
        @enum {string}
    • CephStoragePolicies: {
          ceph_admin_key_id?: string;
          ceph_admin_secret_key?: string;
          DATA_TYPE: "ceph_storage_policies#1.0.0";
          s3_buckets?: string[];
          s3_endpoint?: string;
      }

      CephStoragePolicies

      Connector-specific storage gateway policies for the Ceph connector

      • Optionalceph_admin_key_id?: string

        Administrator key id used to authenticate with the ceph admin service to obtain user credentials.

      • Optionalceph_admin_secret_key?: string

        Administrator secret key used to authenticate with the ceph admin service to obtain user credentials.

      • DATA_TYPE: "ceph_storage_policies#1.0.0"

        Type of this document

        ceph_storage_policies#1.0.0
        @enum {string}
      • Optionals3_buckets?: string[]

        List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this Storage Gateway.

      • Optionals3_endpoint?: string

        URL of the Ceph RADOS Gateway S3 API

    • CephStoragePolicies_1_0_0: {
          ceph_admin_key_id?: string;
          ceph_admin_secret_key?: string;
          DATA_TYPE: "ceph_storage_policies#1.0.0";
          s3_buckets?: string[];
          s3_endpoint?: string;
      }

      CephStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the Ceph connector

      • Optionalceph_admin_key_id?: string

        Administrator key id used to authenticate with the ceph admin service to obtain user credentials.

      • Optionalceph_admin_secret_key?: string

        Administrator secret key used to authenticate with the ceph admin service to obtain user credentials.

      • DATA_TYPE: "ceph_storage_policies#1.0.0"

        Type of this document

        ceph_storage_policies#1.0.0
        @enum {string}
      • Optionals3_buckets?: string[]

        List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this Storage Gateway.

      • Optionals3_endpoint?: string

        URL of the Ceph RADOS Gateway S3 API

    • CephUserCredentialPolicies: { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }

      CephUserCredentialPolicies

      Connector-specific user credential policies for the Ceph connector

      • DATA_TYPE: "ceph_user_credential_policies#1.0.0"

        Type of this document

        ceph_user_credential_policies#1.0.0
        @enum {string}
    • CephUserCredentialPolicies_1_0_0: { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }

      CephUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the Ceph connector

      • DATA_TYPE: "ceph_user_credential_policies#1.0.0"

        Type of this document

        ceph_user_credential_policies#1.0.0
        @enum {string}
    • CheckResult: {
          DATA_TYPE: "check_result#1.0.0";
          error?: null | Record<string, unknown>;
          id?: string;
          message?: string;
      }

      CheckResult

      Consistency check information

      • DATA_TYPE: "check_result#1.0.0"

        Type of this document

        check_result#1.0.0
        @enum {string}
      • Optionalerror?: null | Record<string, unknown>

        Error details

      • Optionalid?: string

        Format: uuid

        ID of the object that was checked

      • Optionalmessage?: string

        Message describing the error

    • CheckResult_1_0_0: {
          DATA_TYPE: "check_result#1.0.0";
          error?: null | Record<string, unknown>;
          id?: string;
          message?: string;
      }

      CheckResult_1_0_0

      Consistency check information

      • DATA_TYPE: "check_result#1.0.0"

        Type of this document

        check_result#1.0.0
        @enum {string}
      • Optionalerror?: null | Record<string, unknown>

        Error details

      • Optionalid?: string

        Format: uuid

        ID of the object that was checked

      • Optionalmessage?: string

        Message describing the error

    • Collection:
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.0.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_verify?: boolean;
              display_name: string;
              domain_name?: string;
              force_encryption?: boolean;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.1.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_verify?: boolean;
              display_name: string;
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null
              | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.2.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_verify?: boolean;
              display_name: string;
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.3.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null
              | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.4.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null
              | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.5.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null
              | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.6.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.7.0";
              default_directory?: string;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              DATA_TYPE: "collection#1.8.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped"
              | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              created_at?: null | string;
              DATA_TYPE: "collection#1.9.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              last_access?: null | string;
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              acl_expiration_mins?: null
              | number;
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped" | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              created_at?: null | string;
              DATA_TYPE: "collection#1.10.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              last_access?: null | string;
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              acl_expiration_mins?: null
              | number;
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped" | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              created_at?: null | string;
              DATA_TYPE: "collection#1.11.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              last_access?: null | string;
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              acl_expiration_mins?: null
              | number;
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              collection_base_path: string;
              collection_type: "mapped" | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              created_at?: null | string;
              DATA_TYPE: "collection#1.12.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              last_access?: null | string;
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              restrict_transfers_to_high_assurance?: | null
              | "inbound"
              | "outbound"
              | "all";
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              acl_expiration_mins?: null
              | number;
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              auto_delete_timeout?: null | number;
              collection_base_path: string;
              collection_type: "mapped" | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              created_at?: null | string;
              DATA_TYPE: "collection#1.13.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              last_access?: null | string;
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              restrict_transfers_to_high_assurance?: | null
              | "inbound"
              | "outbound"
              | "all";
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              skip_auto_delete?: boolean;
              storage_gateway_id?: string;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              acl_expiration_mins?: null
              | number;
              activity_notification_policy?: {
                  status: string[];
                  transfer_use: string[];
              };
              allow_guest_collections?: boolean;
              authentication_timeout_mins?: number;
              auto_delete_timeout?: null
              | number;
              collection_base_path: string;
              collection_type: "mapped" | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              created_at?: null | string;
              DATA_TYPE: "collection#1.14.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              last_access?: null | string;
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              restrict_transfers_to_high_assurance?: | null
              | "inbound"
              | "outbound"
              | "all";
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              skip_auto_delete?: boolean;
              storage_gateway_id?: string;
              subscription_admin_verified?: boolean;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }
          | {
              acl_expiration_mins?: null
              | number;
              activity_notification_policy?: {
                  status: string[];
                  transfer_use: string[];
              };
              allow_guest_collections?: boolean;
              associated_flow_policy?: unknown;
              authentication_timeout_mins?: number;
              auto_delete_timeout?: null
              | number;
              collection_base_path: string;
              collection_type: "mapped" | "guest";
              connector_id?: string;
              contact_email?: null | string;
              contact_info?: null | string;
              created_at?: null | string;
              DATA_TYPE: "collection#1.15.0";
              default_directory?: string;
              delete_protected?: boolean;
              deleted?: boolean;
              department?: null | string;
              description?: null | string;
              disable_anonymous_writes?: boolean;
              disable_verify?: boolean;
              display_name: string;
              domain?: {
                  certificate?: null | string;
                  certificate_chain?: null | string;
                  certificate_chain_path?: null | string;
                  certificate_path?: null | string;
                  DATA_TYPE: "domain#1.0.0";
                  domain_name: string;
                  private_key?: null | string;
                  private_key_path?: null | string;
                  wildcard: boolean;
              };
              domain_name?: string;
              enable_https?: boolean;
              force_encryption?: boolean;
              force_verify?: boolean;
              guest_auth_policy_id?: null
              | string;
              high_assurance?: boolean;
              https_url?: string;
              id?: string;
              identity_id?: string;
              info_link?: null | string;
              keywords?: string[];
              last_access?: null | string;
              manager_url?: string;
              mapped_collection_id?: string;
              organization?: string;
              policies?:
                  | { DATA_TYPE: "s3_collection_policies#1.0.0" }
                  | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
                  | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
                  | { DATA_TYPE: "box_collection_policies#1.0.0" }
                  | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
                  | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                      project?: string;
                  }
                  | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
                  | { DATA_TYPE: "irods_collection_policies#1.0.0" }
                  | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
                  | { DATA_TYPE: "posix_collection_policies#1.0.0" }
                  | {
                      DATA_TYPE: "posix_collection_policies#1.1.0";
                      sharing_groups_allow?: null | string[];
                      sharing_groups_deny?: null | string[];
                  }
                  | {
                      DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                      sharing_groups_allow?: null
                      | string[];
                      sharing_groups_deny?: null | string[];
                  };
              public: boolean;
              require_mfa?: boolean;
              restrict_transfers_to_high_assurance?: | null
              | "inbound"
              | "outbound"
              | "all";
              root_path?: string;
              sharing_restrict_paths?: unknown;
              sharing_users_allow?: null
              | string[];
              sharing_users_deny?: null | string[];
              skip_auto_delete?: boolean;
              storage_gateway_id?: string;
              subscription_admin_verified?: boolean;
              tlsftp_url?: string;
              user_credential_id?: string;
              user_message?: null | string;
              user_message_link?: null | string;
          }

      Collection

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
      
      Version 1.11.0 adds the acl_expiration_mins property to HA guest collection.
      
      Version 1.12.0 adds the restrict_transfers_to_high_assurance property to HA
      collections.
      
      Version 1.13.0 adds the auto_delete_timeout property to mapped collections
      and the skip_auto_delete property to guest collections.
      
      Version 1.14.0 adds the subscription_admin_verified property to collections
      and activity_notification_policy to guest collections.
      
      Version 1.15.0 adds the associated_flow_policy property to the collection.
      
    • Collection_1_0_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.0.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_verify?: boolean;
          display_name: string;
          domain_name?: string;
          force_encryption?: boolean;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
      }

      Collection_1_0_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.0.0"

        Type of this document

        collection#1.0.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

    • Collection_1_1_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.1.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_verify?: boolean;
          display_name: string;
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null
          | string;
          user_message_link?: null | string;
      }

      Collection_1_1_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.1.0"

        Type of this document

        collection#1.1.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_10_0: {
          acl_expiration_mins?: null | number;
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          created_at?: null | string;
          DATA_TYPE: "collection#1.10.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          last_access?: null | string;
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_10_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
      
      • Optionalacl_expiration_mins?: null | number

        Length of time that guest collection permissions are valid. Only settable on HA mapped collections and used by the guest collections attached to it. Set to null to delete any previously set value.

      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • Optional Readonlycreated_at?: null | string

        Format: date

        Date on which this collection was created

      • DATA_TYPE: "collection#1.10.0"

        Type of this document

        collection#1.10.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlylast_access?: null | string

        Format: date

        Date on which this collection was last accessed

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_11_0: {
          acl_expiration_mins?: null | number;
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          created_at?: null | string;
          DATA_TYPE: "collection#1.11.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          last_access?: null | string;
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_11_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
      
      Version 1.11.0 adds the acl_expiration_mins property to HA guest collection.
      
      • Optionalacl_expiration_mins?: null | number

        Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value.

      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • Optional Readonlycreated_at?: null | string

        Format: date

        Date on which this collection was created

      • DATA_TYPE: "collection#1.11.0"

        Type of this document

        collection#1.11.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlylast_access?: null | string

        Format: date

        Date on which this collection was last accessed

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_12_0: {
          acl_expiration_mins?: null | number;
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          created_at?: null | string;
          DATA_TYPE: "collection#1.12.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          last_access?: null | string;
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          restrict_transfers_to_high_assurance?: | null
          | "inbound"
          | "outbound"
          | "all";
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_12_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
      
      Version 1.11.0 adds the acl_expiration_mins property to HA guest collection.
      
      Version 1.12.0 adds the restrict_transfers_to_high_assurance property to HA
      collections.
      
      • Optionalacl_expiration_mins?: null | number

        Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value.

      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • Optional Readonlycreated_at?: null | string

        Format: date

        Date on which this collection was created

      • DATA_TYPE: "collection#1.12.0"

        Type of this document

        collection#1.12.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlylast_access?: null | string

        Format: date

        Date on which this collection was last accessed

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optionalrestrict_transfers_to_high_assurance?: null | "inbound" | "outbound" | "all"

        Flag indicating whether all data transfers to and from this collection require the remote collection be HA. This can only be assigned on high assurance mapped collections. High assurance guest collections inherit the restriction from their associated mapped collections. This may be set to null to disable this feature.

        If a restriction is in place for a collection, then HTTPS access to
        it is disabled.
        
      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_13_0: {
          acl_expiration_mins?: null | number;
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          auto_delete_timeout?: null | number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          created_at?: null | string;
          DATA_TYPE: "collection#1.13.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          last_access?: null | string;
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          restrict_transfers_to_high_assurance?: | null
          | "inbound"
          | "outbound"
          | "all";
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          skip_auto_delete?: boolean;
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_13_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
      
      Version 1.11.0 adds the acl_expiration_mins property to HA guest collection.
      
      Version 1.12.0 adds the restrict_transfers_to_high_assurance property to HA
      collections.
      
      Version 1.13.0 adds the auto_delete_timeout property to mapped collections
      and the skip_auto_delete property to guest collections.
      
      • Optionalacl_expiration_mins?: null | number

        Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value.

      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • Optionalauto_delete_timeout?: null | number

        Number of days before unused guest collections will be automatically deleted. Only settable on mapped collections. Values must be an integer greater than 0. Set to null to disable automatic guest collection deletion for the mapped collection. Defaults to disabled.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • Optional Readonlycreated_at?: null | string

        Format: date

        Date on which this collection was created

      • DATA_TYPE: "collection#1.13.0"

        Type of this document

        collection#1.13.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlylast_access?: null | string

        Format: date

        Date on which this collection was last accessed

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optionalrestrict_transfers_to_high_assurance?: null | "inbound" | "outbound" | "all"

        Flag indicating whether all data transfers to and from this collection require the remote collection be HA. This can only be assigned on high assurance mapped collections. High assurance guest collections inherit the restriction from their associated mapped collections. This may be set to null to disable this feature.

        If a restriction is in place for a collection, then HTTPS access to
        it is disabled.
        
      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalskip_auto_delete?: boolean

        Flag indicating whether the guest collection is subject to automatic deletion if auto_delete_timeout is set on its mapped collection. Only settable on guest collections. Defaults to false.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_14_0: {
          acl_expiration_mins?: null | number;
          activity_notification_policy?: { status: string[]; transfer_use: string[] };
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          auto_delete_timeout?: null | number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          created_at?: null | string;
          DATA_TYPE: "collection#1.14.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          last_access?: null | string;
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          restrict_transfers_to_high_assurance?: | null
          | "inbound"
          | "outbound"
          | "all";
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          skip_auto_delete?: boolean;
          storage_gateway_id?: string;
          subscription_admin_verified?: boolean;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_14_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
      
      Version 1.11.0 adds the acl_expiration_mins property to HA guest collection.
      
      Version 1.12.0 adds the restrict_transfers_to_high_assurance property to HA
      collections.
      
      Version 1.13.0 adds the auto_delete_timeout property to mapped collections
      and the skip_auto_delete property to guest collections.
      
      Version 1.14.0 adds the subscription_admin_verified property to collections
      and activity_notification_policy to guest collections.
      
      • Optionalacl_expiration_mins?: null | number

        Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value.

      • Optionalactivity_notification_policy?: { status: string[]; transfer_use: string[] }
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • Optionalauto_delete_timeout?: null | number

        Number of days before unused guest collections will be automatically deleted. Only settable on mapped collections. Values must be an integer greater than 0. Set to null to disable automatic guest collection deletion for the mapped collection. Defaults to disabled.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • Optional Readonlycreated_at?: null | string

        Format: date

        Date on which this collection was created

      • DATA_TYPE: "collection#1.14.0"

        Type of this document

        collection#1.14.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlylast_access?: null | string

        Format: date

        Date on which this collection was last accessed

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optionalrestrict_transfers_to_high_assurance?: null | "inbound" | "outbound" | "all"

        Flag indicating whether all data transfers to and from this collection require the remote collection be HA. This can only be assigned on high assurance mapped collections. High assurance guest collections inherit the restriction from their associated mapped collections. This may be set to null to disable this feature.

        If a restriction is in place for a collection, then HTTPS access to
        it is disabled.
        
      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalskip_auto_delete?: boolean

        Flag indicating whether the guest collection is subject to automatic deletion if auto_delete_timeout is set on its mapped collection. Only settable on guest collections. Defaults to false.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlysubscription_admin_verified?: boolean

        Flag indicating whether the collection has been marked as verified by the administrator of the subscription associated with this endpoint.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_15_0: {
          acl_expiration_mins?: null | number;
          activity_notification_policy?: { status: string[]; transfer_use: string[] };
          allow_guest_collections?: boolean;
          associated_flow_policy?: unknown;
          authentication_timeout_mins?: number;
          auto_delete_timeout?: null | number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          created_at?: null | string;
          DATA_TYPE: "collection#1.15.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          last_access?: null | string;
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          restrict_transfers_to_high_assurance?: | null
          | "inbound"
          | "outbound"
          | "all";
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          skip_auto_delete?: boolean;
          storage_gateway_id?: string;
          subscription_admin_verified?: boolean;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_15_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      Version 1.10.0 adds the acl_expiration_mins property to HA mapped collections.
      
      Version 1.11.0 adds the acl_expiration_mins property to HA guest collection.
      
      Version 1.12.0 adds the restrict_transfers_to_high_assurance property to HA
      collections.
      
      Version 1.13.0 adds the auto_delete_timeout property to mapped collections
      and the skip_auto_delete property to guest collections.
      
      Version 1.14.0 adds the subscription_admin_verified property to collections
      and activity_notification_policy to guest collections.
      
      Version 1.15.0 adds the associated_flow_policy property to the collection.
      
      • Optionalacl_expiration_mins?: null | number

        Length of time that guest collection permissions are valid. Only settable on HA guest collections and HA mapped collections and used by guest collections attached to it. When set on both the mapped and guest collections, the lesser value is in effect. Set to null to delete any previously set value.

      • Optionalactivity_notification_policy?: { status: string[]; transfer_use: string[] }
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optionalassociated_flow_policy?: unknown

        Policy describing Globus flows to run when the collection is accessed.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • Optionalauto_delete_timeout?: null | number

        Number of days before unused guest collections will be automatically deleted. Only settable on mapped collections. Values must be an integer greater than 0. Set to null to disable automatic guest collection deletion for the mapped collection. Defaults to disabled.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • Optional Readonlycreated_at?: null | string

        Format: date

        Date on which this collection was created

      • DATA_TYPE: "collection#1.15.0"

        Type of this document

        collection#1.15.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlylast_access?: null | string

        Format: date

        Date on which this collection was last accessed

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optionalrestrict_transfers_to_high_assurance?: null | "inbound" | "outbound" | "all"

        Flag indicating whether all data transfers to and from this collection require the remote collection be HA. This can only be assigned on high assurance mapped collections. High assurance guest collections inherit the restriction from their associated mapped collections. This may be set to null to disable this feature.

        If a restriction is in place for a collection, then HTTPS access to
        it is disabled.
        
      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalskip_auto_delete?: boolean

        Flag indicating whether the guest collection is subject to automatic deletion if auto_delete_timeout is set on its mapped collection. Only settable on guest collections. Defaults to false.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlysubscription_admin_verified?: boolean

        Flag indicating whether the collection has been marked as verified by the administrator of the subscription associated with this endpoint.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_2_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.2.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_verify?: boolean;
          display_name: string;
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_2_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.2.0"

        Type of this document

        collection#1.2.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_3_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.3.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null
          | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_3_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.3.0"

        Type of this document

        collection#1.3.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_4_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.4.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null
          | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_4_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.4.0"

        Type of this document

        collection#1.4.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_5_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.5.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null
          | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_5_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.5.0"

        Type of this document

        collection#1.5.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_6_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.6.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_6_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.6.0"

        Type of this document

        collection#1.6.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 64 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_7_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.7.0";
          default_directory?: string;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_7_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.7.0"

        Type of this document

        collection#1.7.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_8_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          DATA_TYPE: "collection#1.8.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_8_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "collection#1.8.0"

        Type of this document

        collection#1.8.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • Collection_1_9_0: {
          allow_guest_collections?: boolean;
          authentication_timeout_mins?: number;
          collection_base_path: string;
          collection_type: "mapped" | "guest";
          connector_id?: string;
          contact_email?: null | string;
          contact_info?: null | string;
          created_at?: null | string;
          DATA_TYPE: "collection#1.9.0";
          default_directory?: string;
          delete_protected?: boolean;
          deleted?: boolean;
          department?: null | string;
          description?: null | string;
          disable_anonymous_writes?: boolean;
          disable_verify?: boolean;
          display_name: string;
          domain?: {
              certificate?: null | string;
              certificate_chain?: null | string;
              certificate_chain_path?: null | string;
              certificate_path?: null | string;
              DATA_TYPE: "domain#1.0.0";
              domain_name: string;
              private_key?: null | string;
              private_key_path?: null | string;
              wildcard: boolean;
          };
          domain_name?: string;
          enable_https?: boolean;
          force_encryption?: boolean;
          force_verify?: boolean;
          guest_auth_policy_id?: null
          | string;
          high_assurance?: boolean;
          https_url?: string;
          id?: string;
          identity_id?: string;
          info_link?: null | string;
          keywords?: string[];
          last_access?: null | string;
          manager_url?: string;
          mapped_collection_id?: string;
          organization?: string;
          policies?:
              | { DATA_TYPE: "s3_collection_policies#1.0.0" }
              | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
              | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
              | { DATA_TYPE: "box_collection_policies#1.0.0" }
              | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
              | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                  project?: string;
              }
              | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
              | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
              | { DATA_TYPE: "irods_collection_policies#1.0.0" }
              | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
              | { DATA_TYPE: "posix_collection_policies#1.0.0" }
              | {
                  DATA_TYPE: "posix_collection_policies#1.1.0";
                  sharing_groups_allow?: null | string[];
                  sharing_groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                  sharing_groups_allow?: null
                  | string[];
                  sharing_groups_deny?: null | string[];
              };
          public: boolean;
          require_mfa?: boolean;
          root_path?: string;
          sharing_restrict_paths?: unknown;
          sharing_users_allow?: null
          | string[];
          sharing_users_deny?: null | string[];
          storage_gateway_id?: string;
          tlsftp_url?: string;
          user_credential_id?: string;
          user_message?: null | string;
          user_message_link?: null | string;
      }

      Collection_1_9_0

      A collection consists of metadata about the collection, a DNS domain for accessing data on the collection, and configuration on the Data Transfer Nodes to access the collection data. Globus Connect Server version 5 supports two types of collections: mapped and guest.

      Version 1.1.0 adds support for enabling or disabling https access for
      individual collections, as well as the ability for collection
      administrators to add an optional message and web link to be shown on
      the Globus Web App when users visit the collection.
      
      Version 1.2.0 adds the ability to enable or disable sharing by specific
      users.
      
      Version 1.3.0 add support for custom DNS domains on collections.
      
      Version 1.4.0 allows optional multi-factor authentication requirements to
      high assurance collections and the ability to require checksums when
      transferring data on this collection.
      
      Version 1.5.0 allows administrators to disable permissions that would allow
      anonymous users to have write access to an endpoint.
      
      Version 1.6.0 allows administrators of mapped collections to associate
      policies that users accessing guest collections must meet beyond the
      guest collection permissions.
      
      Version 1.7.0 increases the maximum allowed length of the user_message
      property.
      
      Version 1.8.0 adds the delete_protected property. While it is set to true
      on a mapped collection, the collection may not be deleted. As of GCS 5.4.69,
      this is true by default.
      
      Version 1.9.0 adds the read-only last_access and created_at properties.
      
      • Optionalallow_guest_collections?: boolean

        Flag indicating if this Collection allows users to create guest collections on it. This is always false if this is a guest collection. If this is changed to false on a mapped collection with associated guest collections, those collections will no longer be accessible.

      • Optional Readonlyauthentication_timeout_mins?: number

        Timeout (in minutes) during which a user is required to have authenticated in a session to access this storage gateway.

      • collection_base_path: string

        Path to be interpreted as the base path when creating a new collection. It is interpreted differently depending on the collection type being created. For a mapped collection, this is an absolute path on the storage system named by the storage_gateway_id. For a guest collection, this is a relative path relative to the value of the root_path attribute on the mapped collection with the same Id as the mapped_collection_id property. This may not be changed once the collection is created.

        Support for `~` was added in API version 1.21.0.
        
      • collection_type: "mapped" | "guest"

        Type of collection. A mapped collection requires an account on the system to access the administrator-defined collection. A guest collection allows users to share access to their data on a Storage Gateway by registering a credential with the GCS Manager.

      • Optional Readonlyconnector_id?: string

        Format: uuid

        Id of the connector type that is used by this collection.

      • Optionalcontact_email?: null | string

        Email address of the support contact for this collection. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: null | string

        Other non-email contact information for the collection, e.g. phone and mailing address. This is visible to end users for support.

      • Optional Readonlycreated_at?: null | string

        Format: date

        Date on which this collection was created

      • DATA_TYPE: "collection#1.9.0"

        Type of this document

        collection#1.9.0
        @enum {string}
      • Optionaldefault_directory?: string

        Default directory when accessing the collection. This may include the special string $USER which is evaluated at access time to be the connector-specific username accessing the data.

        If the collection is mapped collection with a
        **collection_base_path** value of `/`, this value can also begin
        with the values `/~/` and `$HOME`, which are replaced by the user's
        home directory, or `/` if the connector does not support the
        concept of a home directory.
        
      • Optionaldelete_protected?: boolean

        If set to true, this collection can not be deleted. This property is available only on mapped collections. As of GCS 5.4.69, this is true by default.

      • Optional Readonlydeleted?: boolean

        Flag indicating that this collection has been deleted

      • Optionaldepartment?: null | string

        Department within organization that runs the server(s). Searchable. Optional. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: null | string

        A description of the collection.

      • Optionaldisable_anonymous_writes?: boolean

        Flag indicating if guest collections on this mapped collection allow anonymous write permissions or not. This flag is always true for high assurance collections. For non-high assurance mapped collections, the default value is false.

      • Optionaldisable_verify?: boolean

        Flag indicating that this endpoint does not support computing checksums, needed for the verify_checksum option of transfer.

      • display_name: string

        Friendly name for the collection. Unicode string, max 128 characters, no new lines (\r or \n).

      • Optionaldomain?: {
            certificate?: null | string;
            certificate_chain?: null | string;
            certificate_chain_path?: null | string;
            certificate_path?: null | string;
            DATA_TYPE: "domain#1.0.0";
            domain_name: string;
            private_key?: null | string;
            private_key_path?: null | string;
            wildcard: boolean;
        }
        • Optionalcertificate?: null | string

          PEM-Encoded X.509 certificate for this domain

        • Optionalcertificate_chain?: null | string

          PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

        • Optionalcertificate_chain_path?: null | string

          Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

        • Optionalcertificate_path?: null | string

          Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

        • DATA_TYPE: "domain#1.0.0"

          Type of this document

          domain#1.0.0
          @enum {string}
        • domain_name: string

          Domain name

        • Optionalprivate_key?: null | string

          PEM-Encoded private key for the certificate

        • Optionalprivate_key_path?: null | string

          Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

        • wildcard: boolean

          Flag indicating whether this is a wildcard domain or not.

          When setting a custom domain for a mapped collection, the domain
          may optionally be a wildcard domain. If it is a wildcard domain,
          the guest collections will be created as subdomains of the mapped
          collection domain; if not, guest collections will be created as
          subdomains of the endpoint domain.
          
      • Optionaldomain_name?: string

        DNS name of the virtual host serving this collection. For mapped collections which do not have a custom domain, this may be specified as part of the input document to create the collection, otherwise this is a read-only property. When included in the input, the name is restricted to be a subdomain of the endpoint, and the input name label may not start with m- or g-.

      • Optionalenable_https?: boolean

        Boolean flag indicating whether this collection should support HTTPS. This value can be set on mapped collections or guest collections. However, it may not be set to true on a guest collection if the value on the related mapped collection is false.

      • Optionalforce_encryption?: boolean

        Flag indicating whether all data transfers to and from this collection are always encrypted.

        __New in v5.4.17__: If a mapped collection forces encryption, all
        of its guest collections must as well.  If this option is used on a
        mapped collection, the value is propagated to its guest
        collections.
        
      • Optionalforce_verify?: boolean

        Flag indicating that this endpoint requires computing checksums, needed for the verify_checksum option of transfer.

      • Optionalguest_auth_policy_id?: null | string

        Format: uuid

        Authentication policy set on mapped collections and inherited by its guest collections. During authorization, the authentication policy must be satisfied before permissions are considered. Read-only on guest collections. (Added in API 1.15.0)

      • Optional Readonlyhigh_assurance?: boolean

        Flag indicating if this collection is created on a high assurance Storage Gateway.

      • Optional Readonlyhttps_url?: string

        HTTPS URL for the data on this collection.

      • Optional Readonlyid?: string

        Format: uuid

        Unique identifier for this collection. This is assigned by the GCS manager when creating a collection.

      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth identity to who acts as the owner of this collection. This identity is an administrator on the collection.

      • Optionalinfo_link?: null | string

        Link to a web page with more information about the collection

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Optional. Unicode string, max 1024 characters total across all strings.

      • Optional Readonlylast_access?: null | string

        Format: date

        Date on which this collection was last accessed

      • Optional Readonlymanager_url?: string

        URL of the GCS Manager API service for the endpoint hosting this collection.

      • Optionalmapped_collection_id?: string

        Format: uuid

        Unique ID of the Mapped Collection which this guest collection is associated with. This is set on creation and may not be changed. For a Guest Collection, this must be set, and policies related sharing (allow_guest_collections, sharing_restrict_paths) will always reflect the values in the Mapped Collection definition and may not be changed on this Guest Collection.

      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Optional to preserve backward compatibility, but will eventually be required and all clients are encouraged to require users to specify it. Unicode string, max 1024 characters, no new lines.

      • Optionalpolicies?:
            | { DATA_TYPE: "s3_collection_policies#1.0.0" }
            | { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
            | { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
            | { DATA_TYPE: "box_collection_policies#1.0.0" }
            | { DATA_TYPE: "ceph_collection_policies#1.0.0" }
            | { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
                project?: string;
            }
            | { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
            | { DATA_TYPE: "hpss_collection_policies#1.0.0" }
            | { DATA_TYPE: "irods_collection_policies#1.0.0" }
            | { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
            | { DATA_TYPE: "posix_collection_policies#1.0.0" }
            | {
                DATA_TYPE: "posix_collection_policies#1.1.0";
                sharing_groups_allow?: null | string[];
                sharing_groups_deny?: null | string[];
            }
            | {
                DATA_TYPE: "posix_staging_collection_policies#1.0.0";
                sharing_groups_allow?: null
                | string[];
                sharing_groups_deny?: null | string[];
            }

        Connector-specific collection policies

      • public: boolean

        Flag indicating whether this collection is visible to other Globus users.

      • Optional Readonlyrequire_mfa?: boolean

        Flag indicating if the storage_gateway requires multi-factor authentication. Only applies to high assurance storage gateways.

      • Optional Readonlyroot_path?: string

        Absolute root path of the collection. All data access is done relative to this path. On a guest collection, this value is only visible if the caller has an administrator role on both the guest collection and the mapped collection it is created on.

      • Optionalsharing_restrict_paths?: unknown

        Restrictions on which paths may be shared in guest collections related to this mapped collection. On the mapped collection, these paths are relative to the root_path property of the mapped collection. On a guest collection, they are absolute paths from the storage root.

      • Optionalsharing_users_allow?: null | string[]

        List of connector-specific usernames allowed to create new guest collections on this mapped collection.

      • Optionalsharing_users_deny?: null | string[]

        List of connector-specific usernames denied access to create new guest collections on this mapped collection.

      • Optionalstorage_gateway_id?: string

        Format: uuid

        Unique ID of the Storage Gateway which this collection provides access to. This value can not change after the collection is created.

      • Optional Readonlytlsftp_url?: string

        TLSFTP URL for the data on this collection.

      • Optionaluser_credential_id?: string

        Format: uuid

        The ID of the User Credential which is used to access data on this collection. This credential must be owned by the collection's identity_id.

      • Optionaluser_message?: null | string

        A message for clients to display to users when interacting with this collection. For guest collections, this property is read-only and is the same as the value of its related mapped collection. The message may be up to 256 characters long.

      • Optionaluser_message_link?: null | string

        Link to additional messaging for clients to display to users when interacting with this endpoint, linked to an HTTP or HTTPS URL. For guest collections, this property is read-only and is the same as the value of its related mapped collection.

    • CollectionNotFound: { collection_id?: string; DATA_TYPE: "collection_not_found#1.0.0" }

      CollectionNotFound

      Error details when a mapped collection no longer exists when accessing a guest collection.

      • Optionalcollection_id?: string

        Format: uuid

        collection ID

      • DATA_TYPE: "collection_not_found#1.0.0"

        Type of this document

        collection_not_found#1.0.0
        @enum {string}
    • CollectionNotFound_1_0_0: { collection_id?: string; DATA_TYPE: "collection_not_found#1.0.0" }

      CollectionNotFound_1_0_0

      Error details when a mapped collection no longer exists when accessing a guest collection.

      • Optionalcollection_id?: string

        Format: uuid

        collection ID

      • DATA_TYPE: "collection_not_found#1.0.0"

        Type of this document

        collection_not_found#1.0.0
        @enum {string}
    • CollectionOwner: { DATA_TYPE: "collection_owner#1.0.0"; identity_id: string }

      CollectionOwner

      Schema for processing the collection_owner#1.0.0 data type

      • DATA_TYPE: "collection_owner#1.0.0"

        Type of this document

        collection_owner#1.0.0
        @enum {string}
      • identity_id: string

        Format: uuid

        Auth identity ID of the collection owner

    • CollectionOwner_1_0_0: { DATA_TYPE: "collection_owner#1.0.0"; identity_id: string }

      CollectionOwner_1_0_0

      Schema for processing the collection_owner#1.0.0 data type

      • DATA_TYPE: "collection_owner#1.0.0"

        Type of this document

        collection_owner#1.0.0
        @enum {string}
      • identity_id: string

        Format: uuid

        Auth identity ID of the collection owner

    • Connector:
          | {
              DATA_TYPE: "connector#1.0.0";
              display_name: string;
              id: string;
              version?: string;
          }
          | {
              DATA_TYPE: "connector#1.1.0";
              display_name: string;
              id: string;
              is_baa?: boolean;
              is_ha?: boolean;
              version?: string;
          }

      Connector

      Connector information document

          Version 1.1.0 adds information about HA and BAA subscriptions.
      
    • Connector_1_0_0: {
          DATA_TYPE: "connector#1.0.0";
          display_name: string;
          id: string;
          version?: string;
      }

      Connector_1_0_0

      Connector information document

      • DATA_TYPE: "connector#1.0.0"

        Type of this document

        connector#1.0.0
        @enum {string}
      • display_name: string

        Friendly name of the connector

        POSIX
        
      • id: string

        Unique id of this connector type

      • Optionalversion?: string

        Semantic version of this connector implementation

    • Connector_1_1_0: {
          DATA_TYPE: "connector#1.1.0";
          display_name: string;
          id: string;
          is_baa?: boolean;
          is_ha?: boolean;
          version?: string;
      }

      Connector_1_1_0

      Connector information document

          Version 1.1.0 adds information about HA and BAA subscriptions.
      
      • DATA_TYPE: "connector#1.1.0"

        Type of this document

        connector#1.1.0
        @enum {string}
      • display_name: string

        Friendly name of the connector

        POSIX
        
      • id: string

        Unique id of this connector type

      • Optionalis_baa?: boolean

        Subscription for this connector supports a BAA

      • Optionalis_ha?: boolean

        Subscription for this connector supports high assurance

      • Optionalversion?: string

        Semantic version of this connector implementation

    • CredentialNotFound: {
          accounts: {
              DATA_TYPE: "account#1.0.0";
              identity_id?: string;
              storage_gateway_id?: string;
              username?: string;
          }[];
          DATA_TYPE: "credential_not_found#1.0.0";
      }

      CredentialNotFound

      Error details when a user has attempted to use a credential when creating a collection or logging in, but there are multiple mapped identities and none of them have a valid credential.

      • accounts: {
            DATA_TYPE: "account#1.0.0";
            identity_id?: string;
            storage_gateway_id?: string;
            username?: string;
        }[]

        List of available accounts that do not have credentials registered.

      • DATA_TYPE: "credential_not_found#1.0.0"

        Type of this document

        credential_not_found#1.0.0
        @enum {string}
    • CredentialNotFound_1_0_0: {
          accounts: {
              DATA_TYPE: "account#1.0.0";
              identity_id?: string;
              storage_gateway_id?: string;
              username?: string;
          }[];
          DATA_TYPE: "credential_not_found#1.0.0";
      }

      CredentialNotFound_1_0_0

      Error details when a user has attempted to use a credential when creating a collection or logging in, but there are multiple mapped identities and none of them have a valid credential.

      • accounts: {
            DATA_TYPE: "account#1.0.0";
            identity_id?: string;
            storage_gateway_id?: string;
            username?: string;
        }[]

        List of available accounts that do not have credentials registered.

      • DATA_TYPE: "credential_not_found#1.0.0"

        Type of this document

        credential_not_found#1.0.0
        @enum {string}
    • Domain: {
          certificate?: null | string;
          certificate_chain?: null | string;
          certificate_chain_path?: null | string;
          certificate_path?: null | string;
          DATA_TYPE: "domain#1.0.0";
          domain_name: string;
          private_key?: null | string;
          private_key_path?: null | string;
          wildcard: boolean;
      }

      Domain

      Custom domain description

      • Optionalcertificate?: null | string

        PEM-Encoded X.509 certificate for this domain

      • Optionalcertificate_chain?: null | string

        PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

      • Optionalcertificate_chain_path?: null | string

        Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

      • Optionalcertificate_path?: null | string

        Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

      • DATA_TYPE: "domain#1.0.0"

        Type of this document

        domain#1.0.0
        @enum {string}
      • domain_name: string

        Domain name

      • Optionalprivate_key?: null | string

        PEM-Encoded private key for the certificate

      • Optionalprivate_key_path?: null | string

        Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

      • wildcard: boolean

        Flag indicating whether this is a wildcard domain or not.

        When setting a custom domain for a mapped collection, the domain
        may optionally be a wildcard domain. If it is a wildcard domain,
        the guest collections will be created as subdomains of the mapped
        collection domain; if not, guest collections will be created as
        subdomains of the endpoint domain.
        
    • Domain_1_0_0: {
          certificate?: null | string;
          certificate_chain?: null | string;
          certificate_chain_path?: null | string;
          certificate_path?: null | string;
          DATA_TYPE: "domain#1.0.0";
          domain_name: string;
          private_key?: null | string;
          private_key_path?: null | string;
          wildcard: boolean;
      }

      Domain_1_0_0

      Custom domain description

      • Optionalcertificate?: null | string

        PEM-Encoded X.509 certificate for this domain

      • Optionalcertificate_chain?: null | string

        PEM-Encoded X.509 certificate chain for this domain. Only needed if there are intermediate certificates that must also be sent to clients to allow them to verify the certificate.

      • Optionalcertificate_chain_path?: null | string

        Path to a file containing the X.509 certificate chain for this domain. This file path must contain a sequence of valid certificate and be present on each data transfer node.

      • Optionalcertificate_path?: null | string

        Path to a file containing the X.509 certificate for this domain. This file path must contain a valid certificate and be present on each data transfer node.

      • DATA_TYPE: "domain#1.0.0"

        Type of this document

        domain#1.0.0
        @enum {string}
      • domain_name: string

        Domain name

      • Optionalprivate_key?: null | string

        PEM-Encoded private key for the certificate

      • Optionalprivate_key_path?: null | string

        Path to a file containing the private key for this domain. This file path must contain a valid key and be present on each data transfer node.

      • wildcard: boolean

        Flag indicating whether this is a wildcard domain or not.

        When setting a custom domain for a mapped collection, the domain
        may optionally be a wildcard domain. If it is a wildcard domain,
        the guest collections will be created as subdomains of the mapped
        collection domain; if not, guest collections will be created as
        subdomains of the endpoint domain.
        
    • DropboxCollectionPolicies: { DATA_TYPE: "dropbox_collection_policies#1.0.0" }

      DropboxCollectionPolicies

      Connector-specific collection policies for the Dropbox connector

      • DATA_TYPE: "dropbox_collection_policies#1.0.0"

        Type of this document

        dropbox_collection_policies#1.0.0
        @enum {string}
    • DropboxCollectionPolicies_1_0_0: { DATA_TYPE: "dropbox_collection_policies#1.0.0" }

      DropboxCollectionPolicies_1_0_0

      Connector-specific collection policies for the Dropbox connector

      • DATA_TYPE: "dropbox_collection_policies#1.0.0"

        Type of this document

        dropbox_collection_policies#1.0.0
        @enum {string}
    • DropboxStoragePolicies: {
          allow_any_account?: boolean;
          auth_callback?: string;
          client_id: null | string;
          DATA_TYPE: "dropbox_storage_policies#1.0.0";
          secret: null | string;
          user_api_rate_limit?: number;
      }

      DropboxStoragePolicies

      Connector-specific storage gateway policies for the Dropbox connector

      • Optionalallow_any_account?: boolean

        If true, allow users to access personal or external Dropbox accounts. If false (the default), users must use the Dropbox account which matches the username their Globus credential maps to.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Dropbox App Console for the associated client_id in order to process Dropbox credentials.

      • client_id: null | string

        Client ID (App key) of the app created in the Dropbox App Console

      • DATA_TYPE: "dropbox_storage_policies#1.0.0"

        Type of this document

        dropbox_storage_policies#1.0.0
        @enum {string}
      • secret: null | string

        App secret of the app from the Dropbox App Console policy.

      • Optionaluser_api_rate_limit?: number

        User API Rate Limit associated with this client ID in operations per second per user.

    • DropboxStoragePolicies_1_0_0: {
          allow_any_account?: boolean;
          auth_callback?: string;
          client_id: null | string;
          DATA_TYPE: "dropbox_storage_policies#1.0.0";
          secret: null | string;
          user_api_rate_limit?: number;
      }

      DropboxStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the Dropbox connector

      • Optionalallow_any_account?: boolean

        If true, allow users to access personal or external Dropbox accounts. If false (the default), users must use the Dropbox account which matches the username their Globus credential maps to.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Dropbox App Console for the associated client_id in order to process Dropbox credentials.

      • client_id: null | string

        Client ID (App key) of the app created in the Dropbox App Console

      • DATA_TYPE: "dropbox_storage_policies#1.0.0"

        Type of this document

        dropbox_storage_policies#1.0.0
        @enum {string}
      • secret: null | string

        App secret of the app from the Dropbox App Console policy.

      • Optionaluser_api_rate_limit?: number

        User API Rate Limit associated with this client ID in operations per second per user.

    • DropboxUserCredentialPolicies: {
          access_token?: null | string;
          DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          root_info?: Record<string, unknown>;
          scopes?: string[];
          sub?: null | string;
          token_expiry?: string;
      }

      DropboxUserCredentialPolicies

      Connector-specific user credential policies for the Dropbox connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "dropbox_user_credential_policies#1.0.0"

        Type of this document

        dropbox_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh token

      • Optionalroot_info?: Record<string, unknown>

        root_info

        Root path namespace for Dropbox API requests

      • Optionalscopes?: string[]

        OAuth scopes associated with this access token

        [
        "profile",
        "openid",
        "email",
        "account_info.read",
        "files.metadata.read",
        "files.content.write",
        "files.content.read"
        ]
      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • DropboxUserCredentialPolicies_1_0_0: {
          access_token?: null | string;
          DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          root_info?: Record<string, unknown>;
          scopes?: string[];
          sub?: null | string;
          token_expiry?: string;
      }

      DropboxUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the Dropbox connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "dropbox_user_credential_policies#1.0.0"

        Type of this document

        dropbox_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh token

      • Optionalroot_info?: Record<string, unknown>

        root_info

        Root path namespace for Dropbox API requests

      • Optionalscopes?: string[]

        OAuth scopes associated with this access token

        [
        "profile",
        "openid",
        "email",
        "account_info.read",
        "files.metadata.read",
        "files.content.write",
        "files.content.read"
        ]
      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • Endpoint:
          | {
              allow_udt?: boolean;
              contact_email?: string;
              contact_info?: string;
              DATA_TYPE: "endpoint#1.0.0";
              department?: string;
              description?: string;
              display_name: string;
              gcs_manager_url?: string;
              id?: string;
              info_link?: string;
              keywords?: string[];
              max_concurrency?: number;
              max_parallelism?: number;
              network_use: "normal"
              | "minimal"
              | "aggressive"
              | "custom";
              organization?: string;
              preferred_concurrency?: number;
              preferred_parallelism?: number;
              public: boolean;
              subscription_id?: null | string;
          }
          | {
              allow_udt?: boolean;
              contact_email?: string;
              contact_info?: string;
              DATA_TYPE: "endpoint#1.1.0";
              department?: string;
              description?: string;
              display_name: string;
              gcs_manager_url?: string;
              gridftp_control_channel_port?: null
              | number;
              id?: string;
              info_link?: string;
              keywords?: string[];
              max_concurrency?: number;
              max_parallelism?: number;
              network_use: "normal" | "minimal" | "aggressive" | "custom";
              organization?: string;
              preferred_concurrency?: number;
              preferred_parallelism?: number;
              public: boolean;
              subscription_id?: null | string;
          }
          | {
              allow_udt?: boolean;
              contact_email?: string;
              contact_info?: string;
              DATA_TYPE: "endpoint#1.2.0";
              department?: string;
              description?: string;
              display_name: string;
              earliest_last_access?: string;
              gcs_manager_url?: string;
              gridftp_control_channel_port?: null
              | number;
              id?: string;
              info_link?: string;
              keywords?: string[];
              max_concurrency?: number;
              max_parallelism?: number;
              network_use: "normal" | "minimal" | "aggressive" | "custom";
              organization?: string;
              preferred_concurrency?: number;
              preferred_parallelism?: number;
              public: boolean;
              subscription_id?: null | string;
          }

      Endpoint

      A Globus Connect Server endpoint is a deployment of Globus Connect Server version 5. A single endpoint may optionally include multiple data transfer nodes. The endpoint provides a link between a Globus Connect Server deployment and the Globus Transfer service. The endpoint describes services for accessing data via GridFTP and HTTPS and also for configuring and managing the policies associated with that access.

      Version 1.1.0 of the endpoint includes support for customizing the TCP port
      that the GridFTP listens on.
      
      Version 1.2.0 of the endpoint includes read-only earliest_last_access
      to put a limit on collections which are missing a last_access value.
      
    • Endpoint_1_0_0: {
          allow_udt?: boolean;
          contact_email?: string;
          contact_info?: string;
          DATA_TYPE: "endpoint#1.0.0";
          department?: string;
          description?: string;
          display_name: string;
          gcs_manager_url?: string;
          id?: string;
          info_link?: string;
          keywords?: string[];
          max_concurrency?: number;
          max_parallelism?: number;
          network_use: "normal" | "minimal" | "aggressive" | "custom";
          organization?: string;
          preferred_concurrency?: number;
          preferred_parallelism?: number;
          public: boolean;
          subscription_id?: null | string;
      }

      Endpoint_1_0_0

      A Globus Connect Server endpoint is a deployment of Globus Connect Server version 5. A single endpoint may optionally include multiple data transfer nodes. The endpoint provides a link between a Globus Connect Server deployment and the Globus Transfer service. The endpoint describes services for accessing data via GridFTP and HTTPS and also for configuring and managing the policies associated with that access.

      • Optionalallow_udt?: boolean

        Allow data transfer on this endpoint using the UDT protocol

      • Optionalcontact_email?: string

        Email address of the support contact for this endpoint. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: string

        Other non-email contact information for the endpoint, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "endpoint#1.0.0"

        Type of this document

        endpoint#1.0.0
        @enum {string}
      • Optionaldepartment?: string

        Department within organization that runs the server(s). Searchable. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: string

        A description of the endpoint

      • display_name: string

        Friendly name for the endpoint, not unique. Unicode string, no new lines (\r or \n). Searchable.

      • Optional Readonlygcs_manager_url?: string

        URL of the GCS Manager API service for this endpoint

      • Optionalid?: string

        Format: uuid

        Unique identifier for this endpoint

      • Optionalinfo_link?: string

        Link to a web page with more information about the endpoint. The administrator is responsible for running a website at this URL and verifying that it is accepting public connections.

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Unicode string, max 1024 characters total across all strings.

      • Optionalmax_concurrency?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • Optionalmax_parallelism?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • network_use: "normal" | "minimal" | "aggressive" | "custom"

        Control how Globus interacts with this endpoint over the network.

        Allowed values for **network_use** are:
        
        * `normal`
            - The default setting. Uses an average level of concurrency and
              parallelism. The levels depend on the number of physical
              servers in the endpoint.
        * `minimal`
            - Uses a minimal level of concurrency and parallelism.
        * `aggressive`
            - Uses a high level of concurrency and parallelism.
        * `custom`
            - Uses custom values of concurrency and parallelism set by the
              endpoint admin. When setting this level, you must also set
              the **max_concurrency**, **preferred_concurrency**,
              **max_parallelism**, and **preferred_parallelism** properties.
        
        normal
        @enum {string}
      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Unicode string, max 1024 characters, no new lines.

      • Optionalpreferred_concurrency?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • Optionalpreferred_parallelism?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • public: boolean

        Flag indicating whether this endpoint is visible to all other Globus users. If false, only users which have been granted a role on the endpoint or one of its collections, or belong to a domain allowed access to any of its storage gateways may view it.

        true
        
      • Optionalsubscription_id?: null | string

        The id of the subscription that is managing this endpoint. This may be the special value DEFAULT when using this as input to PATCH or PUT to use the caller's default subscription id.

    • Endpoint_1_1_0: {
          allow_udt?: boolean;
          contact_email?: string;
          contact_info?: string;
          DATA_TYPE: "endpoint#1.1.0";
          department?: string;
          description?: string;
          display_name: string;
          gcs_manager_url?: string;
          gridftp_control_channel_port?: null | number;
          id?: string;
          info_link?: string;
          keywords?: string[];
          max_concurrency?: number;
          max_parallelism?: number;
          network_use: "normal" | "minimal" | "aggressive" | "custom";
          organization?: string;
          preferred_concurrency?: number;
          preferred_parallelism?: number;
          public: boolean;
          subscription_id?: null | string;
      }

      Endpoint_1_1_0

      A Globus Connect Server endpoint is a deployment of Globus Connect Server version 5. A single endpoint may optionally include multiple data transfer nodes. The endpoint provides a link between a Globus Connect Server deployment and the Globus Transfer service. The endpoint describes services for accessing data via GridFTP and HTTPS and also for configuring and managing the policies associated with that access.

      Version 1.1.0 of the endpoint includes support for customizing the TCP port
      that the GridFTP listens on.
      
      • Optionalallow_udt?: boolean

        Allow data transfer on this endpoint using the UDT protocol

      • Optionalcontact_email?: string

        Email address of the support contact for this endpoint. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: string

        Other non-email contact information for the endpoint, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "endpoint#1.1.0"

        Type of this document

        endpoint#1.1.0
        @enum {string}
      • Optionaldepartment?: string

        Department within organization that runs the server(s). Searchable. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: string

        A description of the endpoint

      • display_name: string

        Friendly name for the endpoint, not unique. Unicode string, no new lines (\r or \n). Searchable.

      • Optional Readonlygcs_manager_url?: string

        URL of the GCS Manager API service for this endpoint

      • Optionalgridftp_control_channel_port?: null | number

        TCP port for the Globus control channel to listen on. By default, the control channel is passed through 443 with an ALPN header containing the value "ftp".

      • Optionalid?: string

        Format: uuid

        Unique identifier for this endpoint

      • Optionalinfo_link?: string

        Link to a web page with more information about the endpoint. The administrator is responsible for running a website at this URL and verifying that it is accepting public connections.

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Unicode string, max 1024 characters total across all strings.

      • Optionalmax_concurrency?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • Optionalmax_parallelism?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • network_use: "normal" | "minimal" | "aggressive" | "custom"

        Control how Globus interacts with this endpoint over the network.

        Allowed values for **network_use** are:
        
        * `normal`
            - The default setting. Uses an average level of concurrency and
              parallelism. The levels depend on the number of physical
              servers in the endpoint.
        * `minimal`
            - Uses a minimal level of concurrency and parallelism.
        * `aggressive`
            - Uses a high level of concurrency and parallelism.
        * `custom`
            - Uses custom values of concurrency and parallelism set by the
              endpoint admin. When setting this level, you must also set
              the **max_concurrency**, **preferred_concurrency**,
              **max_parallelism**, and **preferred_parallelism** properties.
        
        normal
        @enum {string}
      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Unicode string, max 1024 characters, no new lines.

      • Optionalpreferred_concurrency?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • Optionalpreferred_parallelism?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • public: boolean

        Flag indicating whether this endpoint is visible to all other Globus users. If false, only users which have been granted a role on the endpoint or one of its collections, or belong to a domain allowed access to any of its storage gateways may view it.

        true
        
      • Optionalsubscription_id?: null | string

        The id of the subscription that is managing this endpoint. This may be the special value DEFAULT when using this as input to PATCH or PUT to use the caller's default subscription id.

    • Endpoint_1_2_0: {
          allow_udt?: boolean;
          contact_email?: string;
          contact_info?: string;
          DATA_TYPE: "endpoint#1.2.0";
          department?: string;
          description?: string;
          display_name: string;
          earliest_last_access?: string;
          gcs_manager_url?: string;
          gridftp_control_channel_port?: null | number;
          id?: string;
          info_link?: string;
          keywords?: string[];
          max_concurrency?: number;
          max_parallelism?: number;
          network_use: "normal" | "minimal" | "aggressive" | "custom";
          organization?: string;
          preferred_concurrency?: number;
          preferred_parallelism?: number;
          public: boolean;
          subscription_id?: null | string;
      }

      Endpoint_1_2_0

      A Globus Connect Server endpoint is a deployment of Globus Connect Server version 5. A single endpoint may optionally include multiple data transfer nodes. The endpoint provides a link between a Globus Connect Server deployment and the Globus Transfer service. The endpoint describes services for accessing data via GridFTP and HTTPS and also for configuring and managing the policies associated with that access.

      Version 1.1.0 of the endpoint includes support for customizing the TCP port
      that the GridFTP listens on.
      
      Version 1.2.0 of the endpoint includes read-only earliest_last_access
      to put a limit on collections which are missing a last_access value.
      
      • Optionalallow_udt?: boolean

        Allow data transfer on this endpoint using the UDT protocol

      • Optionalcontact_email?: string

        Email address of the support contact for this endpoint. This is visible to end users so that they may contact your organization for support.

      • Optionalcontact_info?: string

        Other non-email contact information for the endpoint, e.g. phone and mailing address. This is visible to end users for support.

      • DATA_TYPE: "endpoint#1.2.0"

        Type of this document

        endpoint#1.2.0
        @enum {string}
      • Optionaldepartment?: string

        Department within organization that runs the server(s). Searchable. Unicode string, max 1024 characters, no new lines.

      • Optionaldescription?: string

        A description of the endpoint

      • display_name: string

        Friendly name for the endpoint, not unique. Unicode string, no new lines (\r or \n). Searchable.

      • Optional Readonlyearliest_last_access?: string

        Format: date

        Earliest date when this endpoint began tracking last_access for collections

      • Optional Readonlygcs_manager_url?: string

        URL of the GCS Manager API service for this endpoint

      • Optionalgridftp_control_channel_port?: null | number

        TCP port for the Globus control channel to listen on. By default, the control channel is passed through 443 with an ALPN header containing the value "ftp".

      • Optionalid?: string

        Format: uuid

        Unique identifier for this endpoint

      • Optionalinfo_link?: string

        Link to a web page with more information about the endpoint. The administrator is responsible for running a website at this URL and verifying that it is accepting public connections.

      • Optionalkeywords?: string[]

        List of search keywords for the endpoint. Unicode string, max 1024 characters total across all strings.

      • Optionalmax_concurrency?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • Optionalmax_parallelism?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • network_use: "normal" | "minimal" | "aggressive" | "custom"

        Control how Globus interacts with this endpoint over the network.

        Allowed values for **network_use** are:
        
        * `normal`
            - The default setting. Uses an average level of concurrency and
              parallelism. The levels depend on the number of physical
              servers in the endpoint.
        * `minimal`
            - Uses a minimal level of concurrency and parallelism.
        * `aggressive`
            - Uses a high level of concurrency and parallelism.
        * `custom`
            - Uses custom values of concurrency and parallelism set by the
              endpoint admin. When setting this level, you must also set
              the **max_concurrency**, **preferred_concurrency**,
              **max_parallelism**, and **preferred_parallelism** properties.
        
        normal
        @enum {string}
      • Optionalorganization?: string

        Organization that runs the server(s) represented by the endpoint. Unicode string, max 1024 characters, no new lines.

      • Optionalpreferred_concurrency?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • Optionalpreferred_parallelism?: number

        Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

      • public: boolean

        Flag indicating whether this endpoint is visible to all other Globus users. If false, only users which have been granted a role on the endpoint or one of its collections, or belong to a domain allowed access to any of its storage gateways may view it.

        true
        
      • Optionalsubscription_id?: null | string

        The id of the subscription that is managing this endpoint. This may be the special value DEFAULT when using this as input to PATCH or PUT to use the caller's default subscription id.

    • EndpointOwner: { DATA_TYPE: "endpoint_owner#1.0.0"; identity_id: string }

      EndpointOwner

      Schema for processing the endpoint_owner#1.0.0 data type

      • DATA_TYPE: "endpoint_owner#1.0.0"

        Type of this document

        endpoint_owner#1.0.0
        @enum {string}
      • identity_id: string

        Format: uuid

        Auth identity ID of the endpoint owner

    • EndpointOwner_1_0_0: { DATA_TYPE: "endpoint_owner#1.0.0"; identity_id: string }

      EndpointOwner_1_0_0

      Schema for processing the endpoint_owner#1.0.0 data type

      • DATA_TYPE: "endpoint_owner#1.0.0"

        Type of this document

        endpoint_owner#1.0.0
        @enum {string}
      • identity_id: string

        Format: uuid

        Auth identity ID of the endpoint owner

    • EndpointSubscription: { DATA_TYPE: "endpoint_subscription#1.0.0"; subscription_id: null | string }

      EndpointSubscription

      Endpoint subscription

      • DATA_TYPE: "endpoint_subscription#1.0.0"

        Type of this document

        endpoint_subscription#1.0.0
        @enum {string}
      • subscription_id: null | string

        Either the id of a Globus subscription or the special value "DEFAULT" if the caller has only one subscription associated with their identity set.

    • EndpointSubscription_1_0_0: { DATA_TYPE: "endpoint_subscription#1.0.0"; subscription_id: null | string }

      EndpointSubscription_1_0_0

      Endpoint subscription

      • DATA_TYPE: "endpoint_subscription#1.0.0"

        Type of this document

        endpoint_subscription#1.0.0
        @enum {string}
      • subscription_id: null | string

        Either the id of a Globus subscription or the special value "DEFAULT" if the caller has only one subscription associated with their identity set.

    • ExpressionIdentityMapping_1_0_0: {
          DATA_TYPE: "expression_identity_mapping#1.0.0";
          mappings?: {
              ignore_case?: boolean;
              literal?: boolean;
              match?: string;
              output?: string;
              source?: string;
          }[];
      }

      ExpressionIdentityMapping_1_0_0

      The ExpressionIdentityMapping defines a set of identity mapping expressions to map Globus Auth identity data to a connector-specific list of account names.

      • DATA_TYPE: "expression_identity_mapping#1.0.0"

        Type of this document

        expression_identity_mapping#1.0.0
        @enum {string}
      • Optionalmappings?: {
            ignore_case?: boolean;
            literal?: boolean;
            match?: string;
            output?: string;
            source?: string;
        }[]

        Array of expression-based identity mapping values

    • ExternalIdentityMapping_1_0_0: { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }

      ExternalIdentityMapping_1_0_0

      The ExternalIdentityMapping defines the path and arguments of an external program to map an identity to a storage-gateway specific user account name. The specified command will be called to map Globus Auth identity data to a connector-specific list of account names.

      • Optionalcommand?: string[]

        The mapping command and its command-line arguments. In addition to these arguments, the following will also be passed to the program.

        <dl><dt>-c <em>CONNECTOR_ID</em></dt>
        <dd>
        The ID of the connector that the mapping is being
        done in the context of.
        </dd>
        <dt>-s <em>STORAGE_GATEWAY_ID</em></dt>
        <dd>
        The ID of the storage gateway that the mapping is being done in
        the context of.
        </dd>
        <dt>-a</dt>
        <dd>This option is a flag that indicates that the GCS Manager wants to
        receive output containing all mappings for the given identity set.  If
        not present, the program will receive exactly one object in the
        identities array and may only return a single mapping for that
        identity.
        </dd>
        </dl>
        
      • DATA_TYPE: "external_identity_mapping#1.0.0"

        Type of this document

        external_identity_mapping#1.0.0
        @enum {string}
    • Flow: { flow: string }

      Flow

    • FlowAssociation: { transfer?: unknown }

      FlowAssociation

    • FlowTransferAssociation: { destination?: unknown; source?: unknown }

      FlowTransferAssociation

    • GoogleCloudStorageCollectionPolicies: {
          DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
          project?: string;
      }

      GoogleCloudStorageCollectionPolicies

      Connector-specific collection policies for the Google Cloud Storage connector

      • DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0"

        Type of this document

        google_cloud_storage_collection_policies#1.0.0
        @enum {string}
      • Optionalproject?: string

        Google Cloud Platform project ID value that is associated with this collection. If set, users must be a member of this project to access the collection. If the storage gateway 'projects' property is set to exactly one project, that will be the default value for this property.

    • GoogleCloudStorageCollectionPolicies_1_0_0: {
          DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
          project?: string;
      }

      GoogleCloudStorageCollectionPolicies_1_0_0

      Connector-specific collection policies for the Google Cloud Storage connector

      • DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0"

        Type of this document

        google_cloud_storage_collection_policies#1.0.0
        @enum {string}
      • Optionalproject?: string

        Google Cloud Platform project ID value that is associated with this collection. If set, users must be a member of this project to access the collection. If the storage gateway 'projects' property is set to exactly one project, that will be the default value for this property.

    • GoogleCloudStoragePolicies:
          | {
              auth_callback?: string;
              buckets?: null
              | string[];
              client_id: null | string;
              DATA_TYPE: "google_cloud_storage_policies#1.0.0";
              projects?: null | string[];
              secret: null | string;
              service_account_key?: null | Record<string, unknown>;
              user_credential_required?: boolean;
          }
          | {
              allow_any_account?: boolean;
              auth_callback?: string;
              buckets?: null
              | string[];
              client_id: null | string;
              DATA_TYPE: "google_cloud_storage_policies#1.1.0";
              projects?: null | string[];
              secret: null | string;
              service_account_key?: null | Record<string, unknown>;
              user_credential_required?: boolean;
          }

      GoogleCloudStoragePolicies

      Connector-specific storage gateway policies for the Google Cloud Storage connector

    • GoogleCloudStoragePolicies_1_0_0: {
          auth_callback?: string;
          buckets?: null | string[];
          client_id: null | string;
          DATA_TYPE: "google_cloud_storage_policies#1.0.0";
          projects?: null | string[];
          secret: null | string;
          service_account_key?: null | Record<string, unknown>;
          user_credential_required?: boolean;
      }

      GoogleCloudStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the Google Cloud Storage connector

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Google API console for the application client_id in order to process " Google credentials.

      • Optionalbuckets?: null | string[]

        The list of Google Cloud Storage buckets which the Storage Gateway is allowed to access, as well as the list of buckets that will be shown in root level directory listings. If this list is unset, bucket access is unrestricted and all non public credential accessible buckets will be shown in root level directory listings. The value is a list of bucket names.

      • client_id: null | string

        Client ID registered with the Google Application console to access Google Cloud Storage.

      • DATA_TYPE: "google_cloud_storage_policies#1.0.0"

        Type of this document

        google_cloud_storage_policies#1.0.0
        @enum {string}
      • Optionalprojects?: null | string[]

        The list of Google Cloud Storage project ids which the Storage Gateway is allowed to access. If this list is unset, project access is unrestricted. The value is a list of project id strings.

      • secret: null | string

        Secret created to access access Google Cloud Storage with the client_id in this policy.

      • Optionalservice_account_key?: null | Record<string, unknown>

        Service account key to use when authenticating all storage access

      • Optional Readonlyuser_credential_required?: boolean

        Flag indicating whether users must register a credential. If true (or if this property is missing), this storage gateway is configured for OAuth2 user authentication. If false, authentication is configured by the admin.

    • GoogleCloudStoragePolicies_1_1_0: {
          allow_any_account?: boolean;
          auth_callback?: string;
          buckets?: null | string[];
          client_id: null | string;
          DATA_TYPE: "google_cloud_storage_policies#1.1.0";
          projects?: null | string[];
          secret: null | string;
          service_account_key?: null | Record<string, unknown>;
          user_credential_required?: boolean;
      }

      GoogleCloudStoragePolicies_1_1_0

      Connector-specific storage gateway policies for the Google Cloud Storage connector

      • Optionalallow_any_account?: boolean

        If true, allow users to access personal or external Google accounts. If false (the default), users must use the Google account which matches the username their Globus credential maps to.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Google API console for the application client_id in order to process " Google credentials.

      • Optionalbuckets?: null | string[]

        The list of Google Cloud Storage buckets which the Storage Gateway is allowed to access, as well as the list of buckets that will be shown in root level directory listings. If this list is unset, bucket access is unrestricted and all non public credential accessible buckets will be shown in root level directory listings. The value is a list of bucket names.

      • client_id: null | string

        Client ID registered with the Google Application console to access Google Cloud Storage.

      • DATA_TYPE: "google_cloud_storage_policies#1.1.0"

        Type of this document

        google_cloud_storage_policies#1.1.0
        @enum {string}
      • Optionalprojects?: null | string[]

        The list of Google Cloud Storage project ids which the Storage Gateway is allowed to access. If this list is unset, project access is unrestricted. The value is a list of project id strings.

      • secret: null | string

        Secret created to access access Google Cloud Storage with the client_id in this policy.

      • Optionalservice_account_key?: null | Record<string, unknown>

        Service account key to use when authenticating all storage access

      • Optional Readonlyuser_credential_required?: boolean

        Flag indicating whether users must register a credential. If true (or if this property is missing), this storage gateway is configured for OAuth2 user authentication. If false, authentication is configured by the admin.

    • GoogleCloudStorageProject: { name?: string; projectId?: string }

      GoogleCloudStorageProject

      A Google Cloud Platform project resource

      • Optionalname?: string

        The name of the project

      • OptionalprojectId?: string

        Google-issued id of a Google Cloud Platform project

    • GoogleCloudStorageUserCredentialPolicies: {
          access_token?: null | string;
          DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
          email?: string;
          projects?: { name?: string; projectId?: string }[];
          refresh_token?: null | string;
          scopes?: string[];
          sub?: string;
          token_expiry?: string;
      }

      GoogleCloudStorageUserCredentialPolicies

      Connector-specific user credential policies for the Google Cloud Storage connector

      • Optionalaccess_token?: null | string

        Access token to interact with the Google Cloud Storage API

      • DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0"

        Type of this document

        google_cloud_storage_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: string

        OpenID Connect email property of this credential

      • Optionalprojects?: { name?: string; projectId?: string }[]

        List of Google Cloud Platform projects available for use with this credential.

      • Optionalrefresh_token?: null | string

        Refresh token to generate new access tokens to use with the Google Cloud Storage API

      • Optionalscopes?: string[]

        List of OAuth2 scopes associated with the tokens in this credential

      • Optionalsub?: string

        OpenID Connect subject property of this credential

      • Optionaltoken_expiry?: string

        Format: date-time

        Time when he access token expires

    • GoogleCloudStorageUserCredentialPolicies_1_0_0: {
          access_token?: null | string;
          DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
          email?: string;
          projects?: { name?: string; projectId?: string }[];
          refresh_token?: null | string;
          scopes?: string[];
          sub?: string;
          token_expiry?: string;
      }

      GoogleCloudStorageUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the Google Cloud Storage connector

      • Optionalaccess_token?: null | string

        Access token to interact with the Google Cloud Storage API

      • DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0"

        Type of this document

        google_cloud_storage_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: string

        OpenID Connect email property of this credential

      • Optionalprojects?: { name?: string; projectId?: string }[]

        List of Google Cloud Platform projects available for use with this credential.

      • Optionalrefresh_token?: null | string

        Refresh token to generate new access tokens to use with the Google Cloud Storage API

      • Optionalscopes?: string[]

        List of OAuth2 scopes associated with the tokens in this credential

      • Optionalsub?: string

        OpenID Connect subject property of this credential

      • Optionaltoken_expiry?: string

        Format: date-time

        Time when he access token expires

    • GoogleDriveCollectionPolicies: { DATA_TYPE: "google_drive_collection_policies#1.0.0" }

      GoogleDriveCollectionPolicies

      Connector-specific collection policies for the Google Drive connector

      • DATA_TYPE: "google_drive_collection_policies#1.0.0"

        Type of this document

        google_drive_collection_policies#1.0.0
        @enum {string}
    • GoogleDriveCollectionPolicies_1_0_0: { DATA_TYPE: "google_drive_collection_policies#1.0.0" }

      GoogleDriveCollectionPolicies_1_0_0

      Connector-specific collection policies for the Google Drive connector

      • DATA_TYPE: "google_drive_collection_policies#1.0.0"

        Type of this document

        google_drive_collection_policies#1.0.0
        @enum {string}
    • GoogleDriveStoragePolicies:
          | {
              auth_callback?: string;
              client_id: null
              | string;
              DATA_TYPE: "google_drive_storage_policies#1.0.0";
              secret: null | string;
              user_api_rate_quota?: number;
          }
          | {
              allow_any_account?: boolean;
              auth_callback?: string;
              client_id: null
              | string;
              DATA_TYPE: "google_drive_storage_policies#1.1.0";
              secret: null | string;
              user_api_rate_quota?: number;
          }

      GoogleDriveStoragePolicies

      Connector-specific storage gateway policies for the Google Drive connector

    • GoogleDriveStoragePolicies_1_0_0: {
          auth_callback?: string;
          client_id: null | string;
          DATA_TYPE: "google_drive_storage_policies#1.0.0";
          secret: null | string;
          user_api_rate_quota?: number;
      }

      GoogleDriveStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the Google Drive connector

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Google API console for the application client_id in order to process Google credentials.

      • client_id: null | string

        Client ID registered with the Google Application console to access Google Drive.

      • DATA_TYPE: "google_drive_storage_policies#1.0.0"

        Type of this document

        google_drive_storage_policies#1.0.0
        @enum {string}
      • secret: null | string

        Secret created to access access Google Drive with the client_id in this policy.

      • Optionaluser_api_rate_quota?: number

        User API Rate quota associated with this client ID

    • GoogleDriveStoragePolicies_1_1_0: {
          allow_any_account?: boolean;
          auth_callback?: string;
          client_id: null | string;
          DATA_TYPE: "google_drive_storage_policies#1.1.0";
          secret: null | string;
          user_api_rate_quota?: number;
      }

      GoogleDriveStoragePolicies_1_1_0

      Connector-specific storage gateway policies for the Google Drive connector

      • Optionalallow_any_account?: boolean

        If true, allow users to access personal or external Google accounts. If false (the default), users must use the Google account which matches the username their Globus credential maps to.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Google API console for the application client_id in order to process Google credentials.

      • client_id: null | string

        Client ID registered with the Google Application console to access Google Drive.

      • DATA_TYPE: "google_drive_storage_policies#1.1.0"

        Type of this document

        google_drive_storage_policies#1.1.0
        @enum {string}
      • secret: null | string

        Secret created to access access Google Drive with the client_id in this policy.

      • Optionaluser_api_rate_quota?: number

        User API Rate quota associated with this client ID

    • GoogleDriveUserCredentialPolicies: {
          access_token?: null | string;
          DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          scopes?: string[];
          sub?: null | string;
          token_expiry?: string;
      }

      GoogleDriveUserCredentialPolicies

      Connector-specific user credential policies for the Google Drive connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "google_drive_user_credential_policies#1.0.0"

        Type of this document

        google_drive_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh token

      • Optionalscopes?: string[]

        OAuth scopes associated with this access token

        [
        "email",
        "profile",
        "https://www.googleapis.com/auth/drive",
        "https://www.googleapis.com/auth/drive.appfolder"
        ]
      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • GoogleDriveUserCredentialPolicies_1_0_0: {
          access_token?: null | string;
          DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          scopes?: string[];
          sub?: null | string;
          token_expiry?: string;
      }

      GoogleDriveUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the Google Drive connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "google_drive_user_credential_policies#1.0.0"

        Type of this document

        google_drive_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh token

      • Optionalscopes?: string[]

        OAuth scopes associated with this access token

        [
        "email",
        "profile",
        "https://www.googleapis.com/auth/drive",
        "https://www.googleapis.com/auth/drive.appfolder"
        ]
      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • HPSSCollectionPolicies: { DATA_TYPE: "hpss_collection_policies#1.0.0" }

      HPSSCollectionPolicies

      Connector-specific collection policies for the HPSS connector

      • DATA_TYPE: "hpss_collection_policies#1.0.0"

        Type of this document

        hpss_collection_policies#1.0.0
        @enum {string}
    • HPSSCollectionPolicies_1_0_0: { DATA_TYPE: "hpss_collection_policies#1.0.0" }

      HPSSCollectionPolicies_1_0_0

      Connector-specific collection policies for the HPSS connector

      • DATA_TYPE: "hpss_collection_policies#1.0.0"

        Type of this document

        hpss_collection_policies#1.0.0
        @enum {string}
    • HPSSStoragePolicies:
          | {
              authentication_mech: "krb5"
              | "unix";
              authenticator: string;
              DATA_TYPE: "hpss_storage_policies#1.0.0";
              uda_checksum: boolean;
          }
          | {
              authentication_mech: "krb5"
              | "unix";
              authenticator: string;
              DATA_TYPE: "hpss_storage_policies#1.1.0";
              login_name?: string;
              uda_checksum: boolean;
          }

      HPSSStoragePolicies

    • HPSSStoragePolicies_1_0_0: {
          authentication_mech: "krb5" | "unix";
          authenticator: string;
          DATA_TYPE: "hpss_storage_policies#1.0.0";
          uda_checksum: boolean;
      }

      HPSSStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the HPSS connector

      • authentication_mech: "krb5" | "unix"

        The type of authentication the connector will perform when logging into HPSS

      • authenticator: string

        Authenticator used with authentication mech to perform authentication to HPSS. Format is: "<auth_type>:<auth_file>" where <auth_type> is one of "auth_keytab" or "auth_keyfile".

        auth_keytab:/var/hpss/etc/gridftp.keytab
        
      • DATA_TYPE: "hpss_storage_policies#1.0.0"

        Type of this document

        hpss_storage_policies#1.0.0
        @enum {string}
      • uda_checksum: boolean

        Flag that indicates if checksums should be stored within UDAs so that sync-by-checksum transfers can verify the file without staging the file from tape.

    • HPSSStoragePolicies_1_1_0: {
          authentication_mech: "krb5" | "unix";
          authenticator: string;
          DATA_TYPE: "hpss_storage_policies#1.1.0";
          login_name?: string;
          uda_checksum: boolean;
      }

      HPSSStoragePolicies_1_1_0

      • authentication_mech: "krb5" | "unix"

        The type of authentication the connector will perform when logging into HPSS

      • authenticator: string

        Authenticator used with authentication mech to perform authentication to HPSS. Format is: "<auth_type>:<auth_file>" where <auth_type> is one of "auth_keytab" or "auth_keyfile".

        auth_keytab:/var/hpss/etc/gridftp.keytab
        
      • DATA_TYPE: "hpss_storage_policies#1.1.0"

        Type of this document

        hpss_storage_policies#1.1.0
        @enum {string}
      • Optionallogin_name?: string

        Name of the HPSS user in the keytab file that the GridFTP server will use to authenticate to HPSS. This user must have the ability to switch to another HPSS user. Defaults to 'hpssftp' which is also handled special by HPSS with regards to the gate keeper.

      • uda_checksum: boolean

        Flag that indicates if checksums should be stored within UDAs so that sync-by-checksum transfers can verify the file without staging the file from tape.

    • HPSSUserCredentialPolicies: { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }

      HPSSUserCredentialPolicies

      Connector-specific user credential policies for the HPSS connector

      • DATA_TYPE: "hpss_user_credential_policies#1.0.0"

        Type of this document

        hpss_user_credential_policies#1.0.0
        @enum {string}
    • HPSSUserCredentialPolicies_1_0_0: { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }

      HPSSUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the HPSS connector

      • DATA_TYPE: "hpss_user_credential_policies#1.0.0"

        Type of this document

        hpss_user_credential_policies#1.0.0
        @enum {string}
    • IdentityMapping:
          | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
          | {
              DATA_TYPE: "expression_identity_mapping#1.0.0";
              mappings?: {
                  ignore_case?: boolean;
                  literal?: boolean;
                  match?: string;
                  output?: string;
                  source?: string;
              }[];
          }

      IdentityMapping

      Globus Connect Server provides two ways for you to implement a custom Globus identity to account mapping: expression-based and external program

      With expression-based mapping you can write rules that extract data from
      fields in the Globus identity document to form storage gateway-specific
      usernames. If there is a regular relationship between most of your users'
      Identity information to their account names, this is probably the most
      direct way to accomplish the mapping.
      
      With external program mappings you can use any mechanism you like (static
      mapping, ldap, database, etc) to look up account information and return the
      mapped account user name. If you have an account system that has usernames
      without a simple relationship to your users' Globus identities, or that
      requires interfacing with an accounting system, this may be necessary.
      
    • IdNotInIdentitySet: { DATA_TYPE: "id_not_in_identity_set#1.0.0"; id?: string }

      IdNotInIdentitySet

      Error details when a user has authenticated but has requested to act as an identity not in the current identity set.

      • DATA_TYPE: "id_not_in_identity_set#1.0.0"

        Type of this document

        id_not_in_identity_set#1.0.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Requested identity ID

    • IdNotInIdentitySet_1_0_0: { DATA_TYPE: "id_not_in_identity_set#1.0.0"; id?: string }

      IdNotInIdentitySet_1_0_0

      Error details when a user has authenticated but has requested to act as an identity not in the current identity set.

      • DATA_TYPE: "id_not_in_identity_set#1.0.0"

        Type of this document

        id_not_in_identity_set#1.0.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Requested identity ID

    • Info: {
          api_version?: string;
          client_id?: string;
          DATA_TYPE: "info#1.0.0";
          domain_name?: string;
          endpoint_id?: string;
          manager_version?: string;
      }

      Info

      This document contains information about the Globus Connect Server, including its software and supported API version number.

      • Optionalapi_version?: string

        Semantic version of the Globus Connect Server API

      • Optionalclient_id?: string

        Format: uuid

        Client id that created the endpoint

      • DATA_TYPE: "info#1.0.0"

        Type of this document

        info#1.0.0
        @enum {string}
      • Optionaldomain_name?: string

        Domain name for the GCS Manager service

      • Optionalendpoint_id?: string

        Format: uuid

        Transfer endpoint ID managed by this GCS Manager

      • Optionalmanager_version?: string

        Globus Connect Server software version

    • Info_1_0_0: {
          api_version?: string;
          client_id?: string;
          DATA_TYPE: "info#1.0.0";
          domain_name?: string;
          endpoint_id?: string;
          manager_version?: string;
      }

      Info_1_0_0

      This document contains information about the Globus Connect Server, including its software and supported API version number.

      • Optionalapi_version?: string

        Semantic version of the Globus Connect Server API

      • Optionalclient_id?: string

        Format: uuid

        Client id that created the endpoint

      • DATA_TYPE: "info#1.0.0"

        Type of this document

        info#1.0.0
        @enum {string}
      • Optionaldomain_name?: string

        Domain name for the GCS Manager service

      • Optionalendpoint_id?: string

        Format: uuid

        Transfer endpoint ID managed by this GCS Manager

      • Optionalmanager_version?: string

        Globus Connect Server software version

    • InvalidCredential: { DATA_TYPE: "invalid_credential#1.0.0"; user_credential_id: string }

      InvalidCredential

      Error details when the caller's identity maps to an account with a user credential that is in an invalid state.

      • DATA_TYPE: "invalid_credential#1.0.0"

        Type of this document

        invalid_credential#1.0.0
        @enum {string}
      • user_credential_id: string

        Format: uuid

        The ID of the user credential which needs to be fixed before this resource can be accessed.

    • InvalidCredential_1_0_0: { DATA_TYPE: "invalid_credential#1.0.0"; user_credential_id: string }

      InvalidCredential_1_0_0

      Error details when the caller's identity maps to an account with a user credential that is in an invalid state.

      • DATA_TYPE: "invalid_credential#1.0.0"

        Type of this document

        invalid_credential#1.0.0
        @enum {string}
      • user_credential_id: string

        Format: uuid

        The ID of the user credential which needs to be fixed before this resource can be accessed.

    • InvalidInput: {
          DATA_TYPE: "invalid_input#1.0.0";
          errors?: { message: string; property?: string }[];
      }

      InvalidInput

      Error details when the caller has sent an invalid input document.

      • DATA_TYPE: "invalid_input#1.0.0"

        Type of this document

        invalid_input#1.0.0
        @enum {string}
      • Optionalerrors?: { message: string; property?: string }[]

        Optional list of input schema violations, such as missing or unknown properties, or properties with invalid values.

    • InvalidInput_1_0_0: {
          DATA_TYPE: "invalid_input#1.0.0";
          errors?: { message: string; property?: string }[];
      }

      InvalidInput_1_0_0

      Error details when the caller has sent an invalid input document.

      • DATA_TYPE: "invalid_input#1.0.0"

        Type of this document

        invalid_input#1.0.0
        @enum {string}
      • Optionalerrors?: { message: string; property?: string }[]

        Optional list of input schema violations, such as missing or unknown properties, or properties with invalid values.

    • InvalidInputItem: { message: string; property?: string }

      InvalidInputItem

      Invalid input item details.

      • message: string

        Error message describing the invalid input error

      • Optionalproperty?: string

        Name of the property whose value contains the error, if known. May be unset depending on the error.

    • InvalidUser: { DATA_TYPE: "invalid_user#1.0.0"; usernames?: string[] }

      InvalidUser

      Error details when the caller's identity does not map to valid local account.

      • DATA_TYPE: "invalid_user#1.0.0"

        Type of this document

        invalid_user#1.0.0
        @enum {string}
      • Optionalusernames?: string[]

        List of connector-specific usernames

    • InvalidUser_1_0_0: { DATA_TYPE: "invalid_user#1.0.0"; usernames?: string[] }

      InvalidUser_1_0_0

      Error details when the caller's identity does not map to valid local account.

      • DATA_TYPE: "invalid_user#1.0.0"

        Type of this document

        invalid_user#1.0.0
        @enum {string}
      • Optionalusernames?: string[]

        List of connector-specific usernames

    • IrodsCollectionPolicies: { DATA_TYPE: "irods_collection_policies#1.0.0" }

      IrodsCollectionPolicies

      Connector-specific collection policies for the Irods connector

      • DATA_TYPE: "irods_collection_policies#1.0.0"

        Type of this document

        irods_collection_policies#1.0.0
        @enum {string}
    • IrodsCollectionPolicies_1_0_0: { DATA_TYPE: "irods_collection_policies#1.0.0" }

      IrodsCollectionPolicies_1_0_0

      Connector-specific collection policies for the Irods connector

      • DATA_TYPE: "irods_collection_policies#1.0.0"

        Type of this document

        irods_collection_policies#1.0.0
        @enum {string}
    • IrodsEnvironment: { name: string; value: string }

      IrodsEnvironment

      Variables to set in the iRODS client environment.

      • name: string

        Environment variable name

      • value: string

        Environment variable value

    • IrodsStoragePolicies: {
          DATA_TYPE: "irods_storage_policies#1.0.0";
          environment?: { name: string; value: string }[];
          irods_authentication_file?: string;
          irods_environment_file: string;
      }

      IrodsStoragePolicies

      Connector-specific storage gateway policies for the Irods connector

      • DATA_TYPE: "irods_storage_policies#1.0.0"

        Type of this document

        irods_storage_policies#1.0.0
        @enum {string}
      • Optionalenvironment?: { name: string; value: string }[]

        Variables to set in the iRODS client environment

      • Optionalirods_authentication_file?: string

        Path to the irods authentication file

        /var/irods/.irodsA
        
      • irods_environment_file: string

        Path to the irods environment file

        /var/irods/irods_environment.json
        
    • IrodsStoragePolicies_1_0_0: {
          DATA_TYPE: "irods_storage_policies#1.0.0";
          environment?: { name: string; value: string }[];
          irods_authentication_file?: string;
          irods_environment_file: string;
      }

      IrodsStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the Irods connector

      • DATA_TYPE: "irods_storage_policies#1.0.0"

        Type of this document

        irods_storage_policies#1.0.0
        @enum {string}
      • Optionalenvironment?: { name: string; value: string }[]

        Variables to set in the iRODS client environment

      • Optionalirods_authentication_file?: string

        Path to the irods authentication file

        /var/irods/.irodsA
        
      • irods_environment_file: string

        Path to the irods environment file

        /var/irods/irods_environment.json
        
    • IrodsUserCredentialPolicies: { DATA_TYPE: "irods_user_credential_policies#1.0.0" }

      IrodsUserCredentialPolicies

      Connector-specific user credential policies for the Irods connector

      • DATA_TYPE: "irods_user_credential_policies#1.0.0"

        Type of this document

        irods_user_credential_policies#1.0.0
        @enum {string}
    • IrodsUserCredentialPolicies_1_0_0: { DATA_TYPE: "irods_user_credential_policies#1.0.0" }

      IrodsUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the Irods connector

      • DATA_TYPE: "irods_user_credential_policies#1.0.0"

        Type of this document

        irods_user_credential_policies#1.0.0
        @enum {string}
    • LimitExceeded: { DATA_TYPE: "limit_exceeded#1.0.0" }

      LimitExceeded

      Error details when a user would be authorized, but the endpoint has reached a hard resource limit on the type of object being created.

      • DATA_TYPE: "limit_exceeded#1.0.0"

        Type of this document

        limit_exceeded#1.0.0
        @enum {string}
    • LimitExceeded_1_0_0: { DATA_TYPE: "limit_exceeded#1.0.0" }

      LimitExceeded_1_0_0

      Error details when a user would be authorized, but the endpoint has reached a hard resource limit on the type of object being created.

      • DATA_TYPE: "limit_exceeded#1.0.0"

        Type of this document

        limit_exceeded#1.0.0
        @enum {string}
    • MappingExpression: {
          ignore_case?: boolean;
          literal?: boolean;
          match?: string;
          output?: string;
          source?: string;
      }

      MappingExpression

      The MappingExpression document type contains information about a mapping expression, including the input, match, output, and flags used to process this expression.

      • Optionalignore_case?: boolean

        Flag indicating the match should be executed as a case insensitive comparison. If not present, this defaults to false.

      • Optionalliteral?: boolean

        Flag indicating the match expression should be done as a literal match, ignoring any special regular characters. If not present, this defaults to false.

      • Optionalmatch?: string

        An expression which is applied to the output performing interpolation on source for determining if this mapping applies. This requires a full string match on the source.

      • Optionaloutput?: string

        A string representing the result of the mapping if the match succeeded. References to the original identity_set data can be interpolated as in the source property. References to match groups from the match property can be interpolated with numbers (indices starting with 0) surrounded by curly brackets {}.

      • Optionalsource?: string

        A string comprised of text plus identity set data field names surrounded by curly brackets {} which are interpolated into the text.

    • MissingRequiredRole: {
          DATA_TYPE: "missing_required_role#1.0.0";
          roles?: {
              collection?: string;
              role:
                  | "owner"
                  | "administrator"
                  | "access_manager"
                  | "activity_manager"
                  | "activity_monitor"
                  | "access_monitor";
          }[];
      }

      MissingRequiredRole

      Error details when a user has authenticated but lacks a role to be able to perform the requested operation.

      • DATA_TYPE: "missing_required_role#1.0.0"

        Type of this document

        missing_required_role#1.0.0
        @enum {string}
      • Optionalroles?: {
            collection?: string;
            role:
                | "owner"
                | "administrator"
                | "access_manager"
                | "activity_manager"
                | "activity_monitor"
                | "access_monitor";
        }[]

        List of roles authorized to perform this operation

    • MissingRequiredRole_1_0_0: {
          DATA_TYPE: "missing_required_role#1.0.0";
          roles?: {
              collection?: string;
              role:
                  | "owner"
                  | "administrator"
                  | "access_manager"
                  | "activity_manager"
                  | "activity_monitor"
                  | "access_monitor";
          }[];
      }

      MissingRequiredRole_1_0_0

      Error details when a user has authenticated but lacks a role to be able to perform the requested operation.

      • DATA_TYPE: "missing_required_role#1.0.0"

        Type of this document

        missing_required_role#1.0.0
        @enum {string}
      • Optionalroles?: {
            collection?: string;
            role:
                | "owner"
                | "administrator"
                | "access_manager"
                | "activity_manager"
                | "activity_monitor"
                | "access_monitor";
        }[]

        List of roles authorized to perform this operation

    • MissingRequiredScopes: { DATA_TYPE: "missing_required_scopes#1.0.0"; required_scopes?: string[] }

      MissingRequiredScopes

      Error details when a user has authenticated but lacks an OAuth scope to be able to perform the requested operation.

      • DATA_TYPE: "missing_required_scopes#1.0.0"

        Type of this document

        missing_required_scopes#1.0.0
        @enum {string}
      • Optionalrequired_scopes?: string[]

        List of OAuth scope names

    • MissingRequiredScopes_1_0_0: { DATA_TYPE: "missing_required_scopes#1.0.0"; required_scopes?: string[] }

      MissingRequiredScopes_1_0_0

      Error details when a user has authenticated but lacks an OAuth scope to be able to perform the requested operation.

      • DATA_TYPE: "missing_required_scopes#1.0.0"

        Type of this document

        missing_required_scopes#1.0.0
        @enum {string}
      • Optionalrequired_scopes?: string[]

        List of OAuth scope names

    • MissingRoleEntrySchema: {
          collection?: string;
          role:
              | "owner"
              | "administrator"
              | "access_manager"
              | "activity_manager"
              | "activity_monitor"
              | "access_monitor";
      }

      MissingRoleEntrySchema

      Missing required role details.

      • Optionalcollection?: string

        Format: uuid

        The collection which the role must apply to. If omitted, the role must apply to an endpoint.

      • role:
            | "owner"
            | "administrator"
            | "access_manager"
            | "activity_manager"
            | "activity_monitor"
            | "access_monitor"
    • Node:
          | {
              DATA_TYPE: "node#1.0.0";
              id?: string;
              incoming_port_range?: number[];
              ip_addresses: string[];
              outgoing_port_range?: number[];
              status: "active"
              | "inactive";
          }
          | {
              data_interface?: null
              | string;
              DATA_TYPE: "node#1.1.0";
              id?: string;
              incoming_port_range?: number[];
              ip_addresses: string[];
              outgoing_port_range?: number[];
              status: "active" | "inactive";
          }
          | {
              data_interface?: null
              | string;
              data_interface6?: null | string;
              DATA_TYPE: "node#1.2.0";
              id?: string;
              incoming_port_range?: number[];
              ip_addresses: string[];
              outgoing_port_range?: number[];
              status: "active" | "inactive";
          }

      Node

      Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as data transfer nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

      Version 1.1.0 adds support for setting the data interface on a node.
      
      Version 1.2.0 adds support for setting an IPv6 data interface on a node.
      
    • Node_1_0_0: {
          DATA_TYPE: "node#1.0.0";
          id?: string;
          incoming_port_range?: number[];
          ip_addresses: string[];
          outgoing_port_range?: number[];
          status: "active" | "inactive";
      }

      Node_1_0_0

      Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as data transfer nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

      • DATA_TYPE: "node#1.0.0"

        Type of this document

        node#1.0.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Unique id string this node. This is system generated and may not be included in create requests.

      • Optionalincoming_port_range?: number[]

        Allowed port range for incoming TCP data connections

      • ip_addresses: string[]

        List of IP addresses for this node

      • Optionaloutgoing_port_range?: number[]

        Port range used as the source for outgoing TCP data connections

      • status: "active" | "inactive"

        Current status of the Node. If a Node is marked inactive, it will be removed from the DNS entries for this endpoint and will return an error on any attempt to use the Manager API or attempt a Transfer using this node.

    • Node_1_1_0: {
          data_interface?: null | string;
          DATA_TYPE: "node#1.1.0";
          id?: string;
          incoming_port_range?: number[];
          ip_addresses: string[];
          outgoing_port_range?: number[];
          status: "active" | "inactive";
      }

      Node_1_1_0

      Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as data transfer nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

      Version 1.1.0 adds support for setting the data interface on a node.
      
      • Optionaldata_interface?: null | string

        IP address on which this node listens for data transfers

      • DATA_TYPE: "node#1.1.0"

        Type of this document

        node#1.1.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Unique id string this node. This is system generated and may not be included in create requests.

      • Optionalincoming_port_range?: number[]

        Allowed port range for incoming TCP data connections

      • ip_addresses: string[]

        List of IP addresses for this node

      • Optionaloutgoing_port_range?: number[]

        Port range used as the source for outgoing TCP data connections

      • status: "active" | "inactive"

        Current status of the Node. If a Node is marked inactive, it will be removed from the DNS entries for this endpoint and will return an error on any attempt to use the Manager API or attempt a Transfer using this node.

    • Node_1_2_0: {
          data_interface?: null | string;
          data_interface6?: null | string;
          DATA_TYPE: "node#1.2.0";
          id?: string;
          incoming_port_range?: number[];
          ip_addresses: string[];
          outgoing_port_range?: number[];
          status: "active" | "inactive";
      }

      Node_1_2_0

      Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as data transfer nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

      Version 1.1.0 adds support for setting the data interface on a node.
      
      Version 1.2.0 adds support for setting an IPv6 data interface on a node.
      
      • Optionaldata_interface?: null | string

        IP address on which this node listens for data transfers

      • Optionaldata_interface6?: null | string

        IPv6 address on which this node listens for data transfers

      • DATA_TYPE: "node#1.2.0"

        Type of this document

        node#1.2.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Unique id string this node. This is system generated and may not be included in create requests.

      • Optionalincoming_port_range?: number[]

        Allowed port range for incoming TCP data connections

      • ip_addresses: string[]

        List of IP addresses for this node

      • Optionaloutgoing_port_range?: number[]

        Port range used as the source for outgoing TCP data connections

      • status: "active" | "inactive"

        Current status of the Node. If a Node is marked inactive, it will be removed from the DNS entries for this endpoint and will return an error on any attempt to use the Manager API or attempt a Transfer using this node.

    • NotFromAllowedDomain: { allowed_domains?: string[]; DATA_TYPE: "not_from_allowed_domain#1.0.0" }

      NotFromAllowedDomain

      Error details when a user has authenticated but does not have an identity from the required domain to perform the requested action.

      • Optionalallowed_domains?: string[]

        List of domains allowed by this resource

      • DATA_TYPE: "not_from_allowed_domain#1.0.0"

        Type of this document

        not_from_allowed_domain#1.0.0
        @enum {string}
    • NotFromAllowedDomain_1_0_0: { allowed_domains?: string[]; DATA_TYPE: "not_from_allowed_domain#1.0.0" }

      NotFromAllowedDomain_1_0_0

      Error details when a user has authenticated but does not have an identity from the required domain to perform the requested action.

      • Optionalallowed_domains?: string[]

        List of domains allowed by this resource

      • DATA_TYPE: "not_from_allowed_domain#1.0.0"

        Type of this document

        not_from_allowed_domain#1.0.0
        @enum {string}
    • NotResourceOwner: { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string }

      NotResourceOwner

      Error details when a user has authenticated but is not the owner of the resource being acted upon.

      • DATA_TYPE: "not_resource_owner#1.0.0"

        Type of this document

        not_resource_owner#1.0.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Identity ID of the owner of the resource

    • NotResourceOwner_1_0_0: { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string }

      NotResourceOwner_1_0_0

      Error details when a user has authenticated but is not the owner of the resource being acted upon.

      • DATA_TYPE: "not_resource_owner#1.0.0"

        Type of this document

        not_resource_owner#1.0.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Identity ID of the owner of the resource

    • OAuthUserCredentialForm: {
          access_token?: string;
          identity_id: string;
          login_hint?: string;
          redirect_uri: string;
          storage_gateway: string;
      }

      OAuthUserCredentialForm

      • Optionalaccess_token?: string

        Unused

      • identity_id: string

        Format: uuid

        Globus Auth identity id that this credential is associated with

      • Optionallogin_hint?: string

        Mapped account username on the storage gateway

      • redirect_uri: string

        URL to redirect to once the credential registration flow is complete. This should be a maximum of 220 characters to avoid conflicts with connector state limits.

      • storage_gateway: string

        Format: uuid

        Storage gateway to associate the credential with

    • OneDriveCollectionPolicies: { DATA_TYPE: "onedrive_collection_policies#1.0.0" }

      OneDriveCollectionPolicies

      Connector-specific collection policies for the OneDrive connector

      • DATA_TYPE: "onedrive_collection_policies#1.0.0"

        Type of this document

        onedrive_collection_policies#1.0.0
        @enum {string}
    • OneDriveCollectionPolicies_1_0_0: { DATA_TYPE: "onedrive_collection_policies#1.0.0" }

      OneDriveCollectionPolicies_1_0_0

      Connector-specific collection policies for the OneDrive connector

      • DATA_TYPE: "onedrive_collection_policies#1.0.0"

        Type of this document

        onedrive_collection_policies#1.0.0
        @enum {string}
    • OneDriveStoragePolicies:
          | {
              auth_callback?: string;
              client_id: null
              | string;
              DATA_TYPE: "onedrive_storage_policies#1.0.0";
              secret: null | string;
              tenant?: null | string;
              user_api_rate_limit?: number;
          }
          | {
              allow_any_account?: boolean;
              auth_callback?: string;
              client_id: null
              | string;
              DATA_TYPE: "onedrive_storage_policies#1.1.0";
              secret: null | string;
              tenant?: null | string;
              user_api_rate_limit?: number;
          }

      OneDriveStoragePolicies

      Connector-specific storage gateway policies for the OneDrive connector

    • OneDriveStoragePolicies_1_0_0: {
          auth_callback?: string;
          client_id: null | string;
          DATA_TYPE: "onedrive_storage_policies#1.0.0";
          secret: null | string;
          tenant?: null | string;
          user_api_rate_limit?: number;
      }

      OneDriveStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the OneDrive connector

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Microsoft API console for the application client_id in order to process Microsoft credentials.

      • client_id: null | string

        Client ID registered with the Azure console to access OneDrive

      • DATA_TYPE: "onedrive_storage_policies#1.0.0"

        Type of this document

        onedrive_storage_policies#1.0.0
        @enum {string}
      • secret: null | string

        Secret created in the Azure console to access OneDrive with the client_id in this policy.

      • Optionaltenant?: null | string

        Tenant ID of the Microsoft organization. Required when Supported Account Types of the Azure application is set to Single tenant.

      • Optionaluser_api_rate_limit?: number

        User API Rate Limit associated with this client ID in operations per second per user.

    • OneDriveStoragePolicies_1_1_0: {
          allow_any_account?: boolean;
          auth_callback?: string;
          client_id: null | string;
          DATA_TYPE: "onedrive_storage_policies#1.1.0";
          secret: null | string;
          tenant?: null | string;
          user_api_rate_limit?: number;
      }

      OneDriveStoragePolicies_1_1_0

      Connector-specific storage gateway policies for the OneDrive connector

      • Optionalallow_any_account?: boolean

        If true, allow users to access personal or external Microsoft accounts. If false (the default), users must use the Microsoft account which matches the username their Globus credential maps to.

      • Optional Readonlyauth_callback?: string

        URL of the auth callback that must be registered on the Microsoft API console for the application client_id in order to process Microsoft credentials.

      • client_id: null | string

        Client ID registered with the Azure console to access OneDrive

      • DATA_TYPE: "onedrive_storage_policies#1.1.0"

        Type of this document

        onedrive_storage_policies#1.1.0
        @enum {string}
      • secret: null | string

        Secret created in the Azure console to access OneDrive with the client_id in this policy.

      • Optionaltenant?: null | string

        Tenant ID of the Microsoft organization. Required when Supported Account Types of the Azure application is set to Single tenant.

      • Optionaluser_api_rate_limit?: number

        User API Rate Limit associated with this client ID in operations per second per user.

    • OneDriveUserCredentialPolicies: {
          access_token?: null | string;
          DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          scopes?: string[];
          sub?: null | string;
          tid?: string;
          token_expiry?: string;
      }

      OneDriveUserCredentialPolicies

      Connector-specific user credential policies for the OneDrive connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "onedrive_user_credential_policies#1.0.0"

        Type of this document

        onedrive_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh token

      • Optionalscopes?: string[]

        OAuth scopes associated with the access token

        [
        "openid",
        "email",
        "profile",
        "offline_access",
        "files.readwrite.all"
        ]
      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltid?: string
      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • OneDriveUserCredentialPolicies_1_0_0: {
          access_token?: null | string;
          DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
          email?: null | string;
          refresh_token?: null | string;
          scopes?: string[];
          sub?: null | string;
          tid?: string;
          token_expiry?: string;
      }

      OneDriveUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the OneDrive connector

      • Optionalaccess_token?: null | string

        OAuth access token

      • DATA_TYPE: "onedrive_user_credential_policies#1.0.0"

        Type of this document

        onedrive_user_credential_policies#1.0.0
        @enum {string}
      • Optionalemail?: null | string

        OAuth email claim

      • Optionalrefresh_token?: null | string

        OAuth refresh token

      • Optionalscopes?: string[]

        OAuth scopes associated with the access token

        [
        "openid",
        "email",
        "profile",
        "offline_access",
        "files.readwrite.all"
        ]
      • Optionalsub?: null | string

        OAuth subject identifier claim

      • Optionaltid?: string
      • Optionaltoken_expiry?: string

        Format: date-time

        OAuth access token expiration time

    • OwnerString: { DATA_TYPE: "owner_string#1.0.0"; identity_id?: string }

      OwnerString

      Owner string document

      • DATA_TYPE: "owner_string#1.0.0"

        Type of this document

        owner_string#1.0.0
        @enum {string}
      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth Identity id

    • OwnerString_1_0_0: { DATA_TYPE: "owner_string#1.0.0"; identity_id?: string }

      OwnerString_1_0_0

      Owner string document

      • DATA_TYPE: "owner_string#1.0.0"

        Type of this document

        owner_string#1.0.0
        @enum {string}
      • Optionalidentity_id?: string

        Format: uuid

        Globus Auth Identity id

    • PathRestrictions: {
          DATA_TYPE: "path_restrictions#1.0.0";
          none?: string[];
          read?: string[];
          read_write?: string[];
      }

      PathRestrictions

      This object represents the path restrictions for a storage gateway or a sharing path restrictions for a mapped collection.

      The values of each of the path lists in this object are interpreted using
      the POSIX pattern matching notation as described in
      https://pubs.opengroup.org/onlinepubs/9699919799/functions/fnmatch.html[fnmatch(3)]
      with flags set to `0` with additional support for some special
      user-specific value interpolation:
      
      `~`, `$HOME`::
      
      The user's home directory if the storage gateway supports such a concept,
      `/` otherwise
      
      `$USER`::
      
      The effective Storage Gateway-specific username that is being used for data
      access. For a Guest Collection, this is the username of the identity that
      created the Guest Collection.
      
      These restrictions are evaluated at every data access. When
      evaluating restrictions, the user-specific interpolation is
      applied before the file name matching is evaluated.
      
      Globus Connect Server evaluates its path restrictions from
      longest leading expression match to shortest. When pattern
      matching characters are present, they are considered as a lower
      priority match than a literal character, with more specific
      pattern characters given precedence. The precedence is thus
      literal character, bracket expression, `?` (single-character
      wildcard), `*` (wildcard).
      
      If multiple path restrictions apply, all matches are applied
      from longest to shortest, with the following rules for
      overriding values:
      
      ### Path Restriction Override Precedence
      ++++
      <table>
        <tr>
          <th>longer restriction</th>
          <th>shorter restriction</th>
          <th>result</th>
        </tr>
      <tr>
      <td> <pre>read_write</pre>   </td><td> <pre>read</pre>          </td><td> <pre>read_write</pre></td>
      </tr>
      <tr>
      <td> <pre>read_write</pre>   </td><td> <pre>none</pre>          </td><td> <pre>read_write</pre></td>
      </tr>
      <tr>
      <td> <pre>read</pre>         </td><td> <pre>read_write</pre>    </td><td> <pre>read_write</pre></td>
      </tr>
      <tr>
      <td> <pre>read</pre>         </td><td> <pre>none</pre>          </td><td> <pre>read</pre></td>
      </tr>
      <tr>
      <td> <pre>none</pre>         </td><td> <pre>read_write</pre>    </td><td> <pre>none</pre></td>
      </tr>
      <tr>
      <td> <pre>none</pre>         </td><td> <pre>read</pre>          </td><td> <pre>none</pre></td>
      </tr>
      </table>
      ++++
      
      • DATA_TYPE: "path_restrictions#1.0.0"

        Type of this document

        path_restrictions#1.0.0
        @enum {string}
      • Optionalnone?: string[]

        List of paths which are denied any access

      • Optionalread?: string[]

        List of paths which are allowed read-only access

      • Optionalread_write?: string[]

        List of paths which are allowed read-write access

    • PathRestrictions_1_0_0: {
          DATA_TYPE: "path_restrictions#1.0.0";
          none?: string[];
          read?: string[];
          read_write?: string[];
      }

      PathRestrictions_1_0_0

      This object represents the path restrictions for a storage gateway or a sharing path restrictions for a mapped collection.

      The values of each of the path lists in this object are interpreted using
      the POSIX pattern matching notation as described in
      https://pubs.opengroup.org/onlinepubs/9699919799/functions/fnmatch.html[fnmatch(3)]
      with flags set to `0` with additional support for some special
      user-specific value interpolation:
      
      `~`, `$HOME`::
      
      The user's home directory if the storage gateway supports such a concept,
      `/` otherwise
      
      `$USER`::
      
      The effective Storage Gateway-specific username that is being used for data
      access. For a Guest Collection, this is the username of the identity that
      created the Guest Collection.
      
      These restrictions are evaluated at every data access. When
      evaluating restrictions, the user-specific interpolation is
      applied before the file name matching is evaluated.
      
      Globus Connect Server evaluates its path restrictions from
      longest leading expression match to shortest. When pattern
      matching characters are present, they are considered as a lower
      priority match than a literal character, with more specific
      pattern characters given precedence. The precedence is thus
      literal character, bracket expression, `?` (single-character
      wildcard), `*` (wildcard).
      
      If multiple path restrictions apply, all matches are applied
      from longest to shortest, with the following rules for
      overriding values:
      
      ### Path Restriction Override Precedence
      ++++
      <table>
        <tr>
          <th>longer restriction</th>
          <th>shorter restriction</th>
          <th>result</th>
        </tr>
      <tr>
      <td> <pre>read_write</pre>   </td><td> <pre>read</pre>          </td><td> <pre>read_write</pre></td>
      </tr>
      <tr>
      <td> <pre>read_write</pre>   </td><td> <pre>none</pre>          </td><td> <pre>read_write</pre></td>
      </tr>
      <tr>
      <td> <pre>read</pre>         </td><td> <pre>read_write</pre>    </td><td> <pre>read_write</pre></td>
      </tr>
      <tr>
      <td> <pre>read</pre>         </td><td> <pre>none</pre>          </td><td> <pre>read</pre></td>
      </tr>
      <tr>
      <td> <pre>none</pre>         </td><td> <pre>read_write</pre>    </td><td> <pre>none</pre></td>
      </tr>
      <tr>
      <td> <pre>none</pre>         </td><td> <pre>read</pre>          </td><td> <pre>none</pre></td>
      </tr>
      </table>
      ++++
      
      • DATA_TYPE: "path_restrictions#1.0.0"

        Type of this document

        path_restrictions#1.0.0
        @enum {string}
      • Optionalnone?: string[]

        List of paths which are denied any access

      • Optionalread?: string[]

        List of paths which are allowed read-only access

      • Optionalread_write?: string[]

        List of paths which are allowed read-write access

    • PosixCollectionPolicies:
          | { DATA_TYPE: "posix_collection_policies#1.0.0" }
          | {
              DATA_TYPE: "posix_collection_policies#1.1.0";
              sharing_groups_allow?: null | string[];
              sharing_groups_deny?: null | string[];
          }

      PosixCollectionPolicies

      Connector-specific collection policies for the POSIX connector

      Version 1.1.0 of the posix_collection_policies document adds the
      **sharing_groups_allow**, and **sharing_groups_deny** properties.
      
    • PosixCollectionPolicies_1_0_0: { DATA_TYPE: "posix_collection_policies#1.0.0" }

      PosixCollectionPolicies_1_0_0

      Connector-specific collection policies for the POSIX connector

      • DATA_TYPE: "posix_collection_policies#1.0.0"

        Type of this document

        posix_collection_policies#1.0.0
        @enum {string}
    • PosixCollectionPolicies_1_1_0: {
          DATA_TYPE: "posix_collection_policies#1.1.0";
          sharing_groups_allow?: null | string[];
          sharing_groups_deny?: null | string[];
      }

      PosixCollectionPolicies_1_1_0

      Connector-specific collection policies for the POSIX connector

      Version 1.1.0 of the posix_collection_policies document adds the
      **sharing_groups_allow**, and **sharing_groups_deny** properties.
      
      • DATA_TYPE: "posix_collection_policies#1.1.0"

        Type of this document

        posix_collection_policies#1.1.0
        @enum {string}
      • Optionalsharing_groups_allow?: null | string[]

        List of POSIX group names allowed to create shares on this collection

      • Optionalsharing_groups_deny?: null | string[]

        List of POSIX group names denied access to create shares on this collection.

    • PosixStagingCollectionPolicies: {
          DATA_TYPE: "posix_staging_collection_policies#1.0.0";
          sharing_groups_allow?: null | string[];
          sharing_groups_deny?: null | string[];
      }

      PosixStagingCollectionPolicies

      Connector-specific collection policies for the POSIX Staging connector

      • DATA_TYPE: "posix_staging_collection_policies#1.0.0"

        Type of this document

        posix_staging_collection_policies#1.0.0
        @enum {string}
      • Optionalsharing_groups_allow?: null | string[]

        List of POSIX group names allowed to create shares on this collection

      • Optionalsharing_groups_deny?: null | string[]

        List of POSIX group names denied access to create shares on this collection.

    • PosixStagingCollectionPolicies_1_0_0: {
          DATA_TYPE: "posix_staging_collection_policies#1.0.0";
          sharing_groups_allow?: null | string[];
          sharing_groups_deny?: null | string[];
      }

      PosixStagingCollectionPolicies_1_0_0

      Connector-specific collection policies for the POSIX Staging connector

      • DATA_TYPE: "posix_staging_collection_policies#1.0.0"

        Type of this document

        posix_staging_collection_policies#1.0.0
        @enum {string}
      • Optionalsharing_groups_allow?: null | string[]

        List of POSIX group names allowed to create shares on this collection

      • Optionalsharing_groups_deny?: null | string[]

        List of POSIX group names denied access to create shares on this collection.

    • PosixStagingEnvironment: { name: string; value: string }

      PosixStagingEnvironment

      Variables to set in the environment when executing the stage_app.

      • name: string

        Environment variable name

      • value: string

        Environment variable value

    • PosixStagingStoragePolicies: {
          DATA_TYPE: "posix_staging_storage_policies#1.0.0";
          environment?: { name: string; value: string }[];
          groups_allow?: null | string[];
          groups_deny?: null | string[];
          stage_app: string;
      }

      PosixStagingStoragePolicies

      Connector-specific storage gateway policies for the POSIX Staging connector

      • DATA_TYPE: "posix_staging_storage_policies#1.0.0"

        Type of this document

        posix_staging_storage_policies#1.0.0
        @enum {string}
      • Optionalenvironment?: { name: string; value: string }[]

        Variables to set in the environment when executing the stage_app

      • Optionalgroups_allow?: null | string[]

        List of POSIX group names allowed to access this storage gateway

      • Optionalgroups_deny?: null | string[]

        List of POSIX group names denied access this storage gateway

      • stage_app: string

        Path to the stage app

    • PosixStagingStoragePolicies_1_0_0: {
          DATA_TYPE: "posix_staging_storage_policies#1.0.0";
          environment?: { name: string; value: string }[];
          groups_allow?: null | string[];
          groups_deny?: null | string[];
          stage_app: string;
      }

      PosixStagingStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the POSIX Staging connector

      • DATA_TYPE: "posix_staging_storage_policies#1.0.0"

        Type of this document

        posix_staging_storage_policies#1.0.0
        @enum {string}
      • Optionalenvironment?: { name: string; value: string }[]

        Variables to set in the environment when executing the stage_app

      • Optionalgroups_allow?: null | string[]

        List of POSIX group names allowed to access this storage gateway

      • Optionalgroups_deny?: null | string[]

        List of POSIX group names denied access this storage gateway

      • stage_app: string

        Path to the stage app

    • PosixStagingUserCredentialPolicies: { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" }

      PosixStagingUserCredentialPolicies

      Connector-specific user credential policies for the POSIX Staging connector

      • DATA_TYPE: "posix_staging_user_credential_policies#1.0.0"

        Type of this document

        posix_staging_user_credential_policies#1.0.0
        @enum {string}
    • PosixStagingUserCredentialPolicies_1_0_0: { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" }

      PosixStagingUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the POSIX Staging connector

      • DATA_TYPE: "posix_staging_user_credential_policies#1.0.0"

        Type of this document

        posix_staging_user_credential_policies#1.0.0
        @enum {string}
    • PosixStoragePolicies: {
          DATA_TYPE: "posix_storage_policies#1.0.0";
          groups_allow?: null | string[];
          groups_deny?: null | string[];
      }

      PosixStoragePolicies

      Connector-specific storage gateway policies for the POSIX connector.

      • DATA_TYPE: "posix_storage_policies#1.0.0"

        Type of this document

        posix_storage_policies#1.0.0
        @enum {string}
      • Optionalgroups_allow?: null | string[]

        List of POSIX group names allowed to access this storage gateway

      • Optionalgroups_deny?: null | string[]

        List of POSIX group names denied access this storage gateway

    • PosixStoragePolicies_1_0_0: {
          DATA_TYPE: "posix_storage_policies#1.0.0";
          groups_allow?: null | string[];
          groups_deny?: null | string[];
      }

      PosixStoragePolicies_1_0_0

      Connector-specific storage gateway policies for the POSIX connector.

      • DATA_TYPE: "posix_storage_policies#1.0.0"

        Type of this document

        posix_storage_policies#1.0.0
        @enum {string}
      • Optionalgroups_allow?: null | string[]

        List of POSIX group names allowed to access this storage gateway

      • Optionalgroups_deny?: null | string[]

        List of POSIX group names denied access this storage gateway

    • PosixUserCredentialPolicies: { DATA_TYPE: "posix_user_credential_policies#1.0.0" }

      PosixUserCredentialPolicies

      Connector-specific user credential policies for the POSIX connector

      • DATA_TYPE: "posix_user_credential_policies#1.0.0"

        Type of this document

        posix_user_credential_policies#1.0.0
        @enum {string}
    • PosixUserCredentialPolicies_1_0_0: { DATA_TYPE: "posix_user_credential_policies#1.0.0" }

      PosixUserCredentialPolicies_1_0_0

      Connector-specific user credential policies for the POSIX connector

      • DATA_TYPE: "posix_user_credential_policies#1.0.0"

        Type of this document

        posix_user_credential_policies#1.0.0
        @enum {string}
    • ResourceConflict: { DATA_TYPE: "resource_conflict#1.0.0"; resources?: string[] }

      ResourceConflict

      Error details when the caller has attempted to update an object that results in a conflict with some other object.

      • DATA_TYPE: "resource_conflict#1.0.0"

        Type of this document

        resource_conflict#1.0.0
        @enum {string}
      • Optionalresources?: string[]

        List of other resources which conflict with this proposed change.

    • ResourceConflict_1_0_0: { DATA_TYPE: "resource_conflict#1.0.0"; resources?: string[] }

      ResourceConflict_1_0_0

      Error details when the caller has attempted to update an object that results in a conflict with some other object.

      • DATA_TYPE: "resource_conflict#1.0.0"

        Type of this document

        resource_conflict#1.0.0
        @enum {string}
      • Optionalresources?: string[]

        List of other resources which conflict with this proposed change.

    • Result:
          | {
              code: string;
              data?: Record<string, unknown>[];
              DATA_TYPE: "result#1.0.0";
              detail?: unknown;
              has_next_page: boolean;
              http_response_code: number;
              marker?: null | string;
              message?: string;
          }
          | {
              authorization_parameters?: null
              | { [key: string]: unknown };
              code: string;
              data?: Record<string, unknown>[];
              DATA_TYPE: "result#1.1.0";
              detail?: unknown;
              has_next_page: boolean;
              http_response_code: number;
              marker?: null | string;
              message?: string;
          }

      Result

      This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

      Version 1.1.0 adds optional authorization_parameters to help process
      authorization or authentication errors
      
    • Result_1_0_0: {
          code: string;
          data?: Record<string, unknown>[];
          DATA_TYPE: "result#1.0.0";
          detail?: unknown;
          has_next_page: boolean;
          http_response_code: number;
          marker?: null | string;
          message?: string;
      }

      Result_1_0_0

      This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

      • code: string

        String response code

      • Optionaldata?: Record<string, unknown>[]
      • DATA_TYPE: "result#1.0.0"

        Type of this document

        result#1.0.0
        @enum {string}
      • Optionaldetail?: unknown
      • has_next_page: boolean

        Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation.

        false
        
      • http_response_code: number

        Numeric HTTP response code

      • Optionalmarker?: null | string

        Opaque marker that may be passed to this API call to fetch the next page of results if the returned document has has_next_page set to true.

      • Optionalmessage?: string

        Message describing this result

    • Result_1_1_0: {
          authorization_parameters?: null | { [key: string]: unknown };
          code: string;
          data?: Record<string, unknown>[];
          DATA_TYPE: "result#1.1.0";
          detail?: unknown;
          has_next_page: boolean;
          http_response_code: number;
          marker?: null | string;
          message?: string;
      }

      Result_1_1_0

      This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

      Version 1.1.0 adds optional authorization_parameters to help process
      authorization or authentication errors
      
      • Optionalauthorization_parameters?: null | { [key: string]: unknown }
      • code: string

        String response code

      • Optionaldata?: Record<string, unknown>[]
      • DATA_TYPE: "result#1.1.0"

        Type of this document

        result#1.1.0
        @enum {string}
      • Optionaldetail?: unknown
      • has_next_page: boolean

        Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation.

        false
        
      • http_response_code: number

        Numeric HTTP response code

      • Optionalmarker?: null | string

        Opaque marker that may be passed to this API call to fetch the next page of results if the returned document has has_next_page set to true.

      • Optionalmessage?: string

        Message describing this result

    • Role: {
          collection?: null | string;
          DATA_TYPE: "role#1.0.0";
          id?: string;
          principal: string;
          role:
              | "owner"
              | "administrator"
              | "access_manager"
              | "activity_manager"
              | "activity_monitor"
              | "access_monitor";
      }

      Role

      The "Role" document type represents the assignment of a role on an Endpoint or Collection to a Globus identity or group.

      • Optionalcollection?: null | string

        Format: uuid

        Collection Id. This value is omitted when creating an endpoint role or when creating role definitions when creating "collections.

      • DATA_TYPE: "role#1.0.0"

        Type of this document

        role#1.0.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Unique id string for this role assignment. This is system generated and should not be included in create requests.

      • principal: string

        Globus Auth identity or group id URN

      • role:
            | "owner"
            | "administrator"
            | "access_manager"
            | "activity_manager"
            | "activity_monitor"
            | "access_monitor"

        Role assigned to the principal

    • Role_1_0_0: {
          collection?: null | string;
          DATA_TYPE: "role#1.0.0";
          id?: string;
          principal: string;
          role:
              | "owner"
              | "administrator"
              | "access_manager"
              | "activity_manager"
              | "activity_monitor"
              | "access_monitor";
      }

      Role_1_0_0

      The "Role" document type represents the assignment of a role on an Endpoint or Collection to a Globus identity or group.

      • Optionalcollection?: null | string

        Format: uuid

        Collection Id. This value is omitted when creating an endpoint role or when creating role definitions when creating "collections.

      • DATA_TYPE: "role#1.0.0"

        Type of this document

        role#1.0.0
        @enum {string}
      • Optionalid?: string

        Format: uuid

        Unique id string for this role assignment. This is system generated and should not be included in create requests.

      • principal: string

        Globus Auth identity or group id URN

      • role:
            | "owner"
            | "administrator"
            | "access_manager"
            | "activity_manager"
            | "activity_monitor"
            | "access_monitor"

        Role assigned to the principal

    • S3CollectionPolicies: { DATA_TYPE: "s3_collection_policies#1.0.0" }

      S3CollectionPolicies

      Connector-specific collection policies for the S3 connector

      • DATA_TYPE: "s3_collection_policies#1.0.0"

        Type of this document

        s3_collection_policies#1.0.0
        @enum {string}
    • S3CollectionPolicies_1_0_0: { DATA_TYPE: "s3_collection_policies#1.0.0" }

      S3CollectionPolicies_1_0_0

      Connector-specific collection policies for the S3 connector

      • DATA_TYPE: "s3_collection_policies#1.0.0"

        Type of this document

        s3_collection_policies#1.0.0
        @enum {string}
    • S3KeysPrefixPaths_1_0_0: {
          path_prefixes: string[];
          s3_key_id?: null | string;
          s3_secret_key?: null | string;
      }

      S3KeysPrefixPaths_1_0_0

      • path_prefixes: string[]

        A list of matching prefix strings. When a S3 object is being accessed its virtual path / is matched against each string in this list. If the virtual path starts with a value in this list then the s3 keys in this object will be used.

      • Optionals3_key_id?: null | string

        Access Key ID to use with the S3 API to access your buckets and objects.

      • Optionals3_secret_key?: null | string

        Secret key to use with the S3 API to access your buckets and objects. If set to null when calling PATCH it indicates that this entry should be deleted.

      • S3StoragePolicies:
            | {
                DATA_TYPE: "s3_storage_policies#1.0.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_user_credential_required?: boolean;
            }
            | {
                DATA_TYPE: "s3_storage_policies#1.1.0";
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_requester_pays?: boolean;
                s3_user_credential_required?: boolean;
            }
            | {
                DATA_TYPE: "s3_storage_policies#1.2.0";
                s3_allow_multi_keys?: boolean;
                s3_buckets?: string[];
                s3_endpoint?: string;
                s3_requester_pays?: boolean;
                s3_user_credential_required?: boolean;
            }

        S3StoragePolicies

        Connector-specific storage gateway policies for the S3 connector

        Version 1.1.0 adds support for the s3_requester_pays property
        
        Version 1.2.0 adds support for the s3_allow_multi_keys property
        
      • S3StoragePolicies_1_0_0: {
            DATA_TYPE: "s3_storage_policies#1.0.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_user_credential_required?: boolean;
        }

        S3StoragePolicies_1_0_0

        Connector-specific storage gateway policies for the S3 connector

        • DATA_TYPE: "s3_storage_policies#1.0.0"

          Type of this document

          s3_storage_policies#1.0.0
          @enum {string}
        • Optionals3_buckets?: string[]

          List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this storage gateway.

        • Optionals3_endpoint?: string

          URL of the S3 API endpoint

          https://s3.amazonaws.com
          
        • Optionals3_user_credential_required?: boolean

          Flag indicating if a Globus User must register a user credential in order to create a guest collection on this storage gateway.

      • S3StoragePolicies_1_1_0: {
            DATA_TYPE: "s3_storage_policies#1.1.0";
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_requester_pays?: boolean;
            s3_user_credential_required?: boolean;
        }

        S3StoragePolicies_1_1_0

        Connector-specific storage gateway policies for the S3 connector

        Version 1.1.0 adds support for the s3_requester_pays property
        
        • DATA_TYPE: "s3_storage_policies#1.1.0"

          Type of this document

          s3_storage_policies#1.1.0
          @enum {string}
        • Optionals3_buckets?: string[]

          List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this storage gateway.

        • Optionals3_endpoint?: string

          URL of the S3 API endpoint

          https://s3.amazonaws.com
          
        • Optionals3_requester_pays?: boolean

          Flag indicating that S3 operations will be charged to the account of the registered credentials. Credentials used with a storage gateway that has the s3_requester_pays property set to true are invalid unless they also have this property set to true as an acknowledgement.

        • Optionals3_user_credential_required?: boolean

          Flag indicating if a Globus User must register a user credential in order to create a guest collection on this storage gateway.

      • S3StoragePolicies_1_2_0: {
            DATA_TYPE: "s3_storage_policies#1.2.0";
            s3_allow_multi_keys?: boolean;
            s3_buckets?: string[];
            s3_endpoint?: string;
            s3_requester_pays?: boolean;
            s3_user_credential_required?: boolean;
        }

        S3StoragePolicies_1_2_0

        Connector-specific storage gateway policies for the S3 connector

        Version 1.1.0 adds support for the s3_requester_pays property
        
        Version 1.2.0 adds support for the s3_allow_multi_keys property
        
        • DATA_TYPE: "s3_storage_policies#1.2.0"

          Type of this document

          s3_storage_policies#1.2.0
          @enum {string}
        • Optionals3_allow_multi_keys?: boolean

          Allow users of this gateway to add multiple s3 IAM keys to their credentials

        • Optionals3_buckets?: string[]

          List of buckets not owned by the collection owner that will be shown in the root of collections created at the base of this storage gateway.

        • Optionals3_endpoint?: string

          URL of the S3 API endpoint

          https://s3.amazonaws.com
          
        • Optionals3_requester_pays?: boolean

          Flag indicating that S3 operations will be charged to the account of the registered credentials. Credentials used with a storage gateway that has the s3_requester_pays property set to true are invalid unless they also have this property set to true as an acknowledgement.

        • Optionals3_user_credential_required?: boolean

          Flag indicating if a Globus User must register a user credential in order to create a guest collection on this storage gateway.

      • S3UserCredentialPolicies:
            | {
                DATA_TYPE: "s3_user_credential_policies#1.0.0";
                s3_key_id?: null
                | string;
                s3_secret_key?: null | string;
            }
            | {
                DATA_TYPE: "s3_user_credential_policies#1.1.0";
                s3_key_id?: null
                | string;
                s3_requester_pays?: boolean;
                s3_secret_key?: null | string;
            }
            | {
                DATA_TYPE: "s3_user_credential_policies#1.2.0";
                s3_key_id?: null
                | string;
                s3_multi_keys?:
                    | null
                    | {
                        path_prefixes: string[];
                        s3_key_id?: null
                        | string;
                        s3_secret_key?: null | string;
                    }[];
                s3_requester_pays?: boolean;
                s3_secret_key?: null
                | string;
            }

        S3UserCredentialPolicies

        Connector-specific user credential policies for the S3 connector

        Version 1.1.0 adds support for the s3_requester_pays property.
        
        Version 1.2.0 adds support for the s3_multi_keys property list.
        
      • S3UserCredentialPolicies_1_0_0: {
            DATA_TYPE: "s3_user_credential_policies#1.0.0";
            s3_key_id?: null | string;
            s3_secret_key?: null | string;
        }

        S3UserCredentialPolicies_1_0_0

        Connector-specific user credential policies for the S3 connector

        • DATA_TYPE: "s3_user_credential_policies#1.0.0"

          Type of this document

          s3_user_credential_policies#1.0.0
          @enum {string}
        • Optionals3_key_id?: null | string

          Access Key ID to use with the S3 API to access your buckets and objects.

        • Optionals3_secret_key?: null | string

          Secret key to use with the S3 API to access your buckets and objects.

      • S3UserCredentialPolicies_1_1_0: {
            DATA_TYPE: "s3_user_credential_policies#1.1.0";
            s3_key_id?: null | string;
            s3_requester_pays?: boolean;
            s3_secret_key?: null | string;
        }

        S3UserCredentialPolicies_1_1_0

        Connector-specific user credential policies for the S3 connector

        Version 1.1.0 adds support for the s3_requester_pays property.
        
        • DATA_TYPE: "s3_user_credential_policies#1.1.0"

          Type of this document

          s3_user_credential_policies#1.1.0
          @enum {string}
        • Optionals3_key_id?: null | string

          Access Key ID to use with the S3 API to access your buckets and objects.

        • Optionals3_requester_pays?: boolean

          Flag indicating the user acknowledges S3 operations will be charged to the account of this credential. If this flag is true in the storage gateway policy, this must also be true or the credential will be invalid.

        • Optionals3_secret_key?: null | string

          Secret key to use with the S3 API to access your buckets and objects.

      • S3UserCredentialPolicies_1_2_0: {
            DATA_TYPE: "s3_user_credential_policies#1.2.0";
            s3_key_id?: null | string;
            s3_multi_keys?:
                | null
                | {
                    path_prefixes: string[];
                    s3_key_id?: null
                    | string;
                    s3_secret_key?: null | string;
                }[];
            s3_requester_pays?: boolean;
            s3_secret_key?: null
            | string;
        }

        S3UserCredentialPolicies_1_2_0

        Connector-specific user credential policies for the S3 connector

        Version 1.1.0 adds support for the s3_requester_pays property.
        
        Version 1.2.0 adds support for the s3_multi_keys property list.
        
        • DATA_TYPE: "s3_user_credential_policies#1.2.0"

          Type of this document

          s3_user_credential_policies#1.2.0
          @enum {string}
        • Optionals3_key_id?: null | string

          Access Key ID to use with the S3 API to access your buckets and objects.

        • Optionals3_multi_keys?:
              | null
              | {
                  path_prefixes: string[];
                  s3_key_id?: null
                  | string;
                  s3_secret_key?: null | string;
              }[]

          A list of path prefixes and S3 key pairs to use with them.

        • Optionals3_requester_pays?: boolean

          Flag indicating the user acknowledges S3 operations will be charged to the account of this credential. If this flag is true in the storage gateway policy, this must also be true or the credential will be invalid.

        • Optionals3_secret_key?: null | string

          Secret key to use with the S3 API to access your buckets and objects.

      • SharingPolicy: {
            collection_id: string;
            DATA_TYPE: "sharing_policy#1.0.0";
            id?: string;
            sharing_restrict_paths: {
                DATA_TYPE: "path_restrictions#1.0.0";
                none?: string[];
                read?: string[];
                read_write?: string[];
            };
            users?: string[];
        }

        SharingPolicy

        Sharing policies for a mapped collection.

        This document type allows endpoint and collection administrators to
        optionally constrain sharing path policies for particular users. The
        **sharing_restrict_paths** property has a similar meaning to that of the
        **sharing_restrict_paths** in the collection document; however, it is in
        effect only for specific users.
        
        If the **users** property is null, then the restriction applies to all
        users. If it is non-null, then this restriction applies only to accounts
        which have been mapped to the enumerated storage gateway user accounts.
        
        Multiple sharing policies can be defined for a mapped collection.  When a
        guest collection is created or accessed, only the policies relevant to the
        user which created the account are enforced.
        
        • collection_id: string

          Format: uuid

          Id of the mapped collection which this policy is associated with

        • DATA_TYPE: "sharing_policy#1.0.0"

          Type of this document

          sharing_policy#1.0.0
          @enum {string}
        • Optionalid?: string

          Format: uuid

          Unique id for this sharing policy

        • sharing_restrict_paths: {
              DATA_TYPE: "path_restrictions#1.0.0";
              none?: string[];
              read?: string[];
              read_write?: string[];
          }

          Restrictions on which paths may be shared in guest collections related to this mapped collection. These paths are relative to the root_path property of the mapped collection.

          • DATA_TYPE: "path_restrictions#1.0.0"

            Type of this document

            path_restrictions#1.0.0
            @enum {string}
          • Optionalnone?: string[]

            List of paths which are denied any access

          • Optionalread?: string[]

            List of paths which are allowed read-only access

          • Optionalread_write?: string[]

            List of paths which are allowed read-write access

        • Optionalusers?: string[]

          List of local user accounts that this policy applies to. If omitted or null, this restriction applies to all local user accounts.

      • SharingPolicy_1_0_0: {
            collection_id: string;
            DATA_TYPE: "sharing_policy#1.0.0";
            id?: string;
            sharing_restrict_paths: {
                DATA_TYPE: "path_restrictions#1.0.0";
                none?: string[];
                read?: string[];
                read_write?: string[];
            };
            users?: string[];
        }

        SharingPolicy_1_0_0

        Sharing policies for a mapped collection.

        This document type allows endpoint and collection administrators to
        optionally constrain sharing path policies for particular users. The
        **sharing_restrict_paths** property has a similar meaning to that of the
        **sharing_restrict_paths** in the collection document; however, it is in
        effect only for specific users.
        
        If the **users** property is null, then the restriction applies to all
        users. If it is non-null, then this restriction applies only to accounts
        which have been mapped to the enumerated storage gateway user accounts.
        
        Multiple sharing policies can be defined for a mapped collection.  When a
        guest collection is created or accessed, only the policies relevant to the
        user which created the account are enforced.
        
        • collection_id: string

          Format: uuid

          Id of the mapped collection which this policy is associated with

        • DATA_TYPE: "sharing_policy#1.0.0"

          Type of this document

          sharing_policy#1.0.0
          @enum {string}
        • Optionalid?: string

          Format: uuid

          Unique id for this sharing policy

        • sharing_restrict_paths: {
              DATA_TYPE: "path_restrictions#1.0.0";
              none?: string[];
              read?: string[];
              read_write?: string[];
          }

          Restrictions on which paths may be shared in guest collections related to this mapped collection. These paths are relative to the root_path property of the mapped collection.

          • DATA_TYPE: "path_restrictions#1.0.0"

            Type of this document

            path_restrictions#1.0.0
            @enum {string}
          • Optionalnone?: string[]

            List of paths which are denied any access

          • Optionalread?: string[]

            List of paths which are allowed read-only access

          • Optionalread_write?: string[]

            List of paths which are allowed read-write access

        • Optionalusers?: string[]

          List of local user accounts that this policy applies to. If omitted or null, this restriction applies to all local user accounts.

      • StorageGateway:
            | {
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.0.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            }
            | {
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.1.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            }
            | {
                admin_managed_credentials: boolean;
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.2.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            }
            | {
                admin_managed_credentials: boolean;
                allowed_domains?: string[];
                authentication_assurance_timeout?: null
                | number;
                authentication_timeout_mins?: null | number;
                connector_id?: string;
                DATA_TYPE: "storage_gateway#1.3.0";
                deleted?: boolean;
                display_name?: string;
                high_assurance?: null | boolean;
                id?: string;
                identity_mappings?:
                    | null
                    | (
                        | {
                            command?: string[];
                            DATA_TYPE: "external_identity_mapping#1.0.0";
                        }
                        | {
                            DATA_TYPE: "expression_identity_mapping#1.0.0";
                            mappings?: {
                                ignore_case?: (...)
                                | (...)
                                | (...);
                                literal?: (...) | (...) | (...);
                                match?: (...) | (...);
                                output?: (...) | (...);
                                source?: (...) | (...);
                            }[];
                        }
                    )[];
                load_dsi_module?: null
                | string;
                max_concurrency?: number;
                max_parallelism?: number;
                network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
                policies?:
                    | {
                        DATA_TYPE: "s3_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.1.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        DATA_TYPE: "s3_storage_policies#1.2.0";
                        s3_allow_multi_keys?: boolean;
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                        s3_requester_pays?: boolean;
                        s3_user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        account: null
                        | string;
                        adls: null | boolean;
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        auth_type: null | string;
                        client_id: null | string;
                        DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                        secret: null | string;
                        tenant: null | string;
                        user_credential_required?: boolean;
                    }
                    | {
                        bp_access_id_file?: string;
                        DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                        s3_endpoint?: string;
                    }
                    | {
                        boxAppSettings: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        DATA_TYPE: "box_storage_policies#1.0.0";
                        enterpriseID: string;
                    }
                    | {
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.1.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        boxAppSettings?: {
                            appAuth: {
                                passphrase: string;
                                privateKey: string;
                                publicKeyID: string;
                            };
                            clientID: string;
                            clientSecret: string;
                        };
                        client_id?: string;
                        DATA_TYPE: "box_storage_policies#1.2.0";
                        enterpriseID?: string;
                        secret?: string;
                        user_api_rate_limit?: number;
                        user_credential_required?: boolean;
                    }
                    | {
                        ceph_admin_key_id?: string;
                        ceph_admin_secret_key?: string;
                        DATA_TYPE: "ceph_storage_policies#1.0.0";
                        s3_buckets?: string[];
                        s3_endpoint?: string;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "dropbox_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        buckets?: null
                        | string[];
                        client_id: null | string;
                        DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                        projects?: null | string[];
                        secret: null | string;
                        service_account_key?: null | Record<string, unknown>;
                        user_credential_required?: boolean;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.0.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "google_drive_storage_policies#1.1.0";
                        secret: null | string;
                        user_api_rate_quota?: number;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.0.0";
                        uda_checksum: boolean;
                    }
                    | {
                        authentication_mech: "krb5"
                        | "unix";
                        authenticator: string;
                        DATA_TYPE: "hpss_storage_policies#1.1.0";
                        login_name?: string;
                        uda_checksum: boolean;
                    }
                    | {
                        DATA_TYPE: "irods_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        irods_authentication_file?: string;
                        irods_environment_file: string;
                    }
                    | {
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.0.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        allow_any_account?: boolean;
                        auth_callback?: string;
                        client_id: null
                        | string;
                        DATA_TYPE: "onedrive_storage_policies#1.1.0";
                        secret: null | string;
                        tenant?: null | string;
                        user_api_rate_limit?: number;
                    }
                    | {
                        DATA_TYPE: "posix_storage_policies#1.0.0";
                        groups_allow?: null
                        | string[];
                        groups_deny?: null | string[];
                    }
                    | {
                        DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                        environment?: { name: string; value: string }[];
                        groups_allow?: null | string[];
                        groups_deny?: null | string[];
                        stage_app: string;
                    };
                preferred_concurrency?: number;
                preferred_parallelism?: number;
                process_user?: null
                | string;
                require_high_assurance?: null | boolean;
                require_mfa: boolean;
                restrict_paths?: unknown;
                users_allow?: null | string[];
                users_deny?: null | string[];
            }

        StorageGateway

        A storage gateway provides the access policies for the endpoint's connected storage systems. It is a named interface by which authorized users can create and manage collections on the connected storage system. A single storage system may be associated with multiple storage gateways, each with its own policies.

        Storage gateway policies describe what type connector the storage
        gateway uses, the paths it allows access to, the login
        requirements are for the storage gateway, and the algorithm to
        map Globus identities to the user namespace of the storage
        gateway (e.g. local accounts).
        
        Version 1.1.0 includes support for multi-factor authentication requirements
        for high assurance storage gateways.
        
        Version 1.2.0 includes support for admin managed credentials.
        
        Version 1.3.0 includes support for overriding the endpoint's network use
        parameters on a storage gateway.
        
      • StorageGateway_1_0_0: {
            allowed_domains?: string[];
            authentication_assurance_timeout?: null | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.0.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        }

        StorageGateway_1_0_0

        A storage gateway provides the access policies for the endpoint's connected storage systems. It is a named interface by which authorized users can create and manage collections on the connected storage system. A single storage system may be associated with multiple storage gateways, each with its own policies.

        Storage gateway policies describe what type connector the storage
        gateway uses, the paths it allows access to, the login
        requirements are for the storage gateway, and the algorithm to
        map Globus identities to the user namespace of the storage
        gateway (e.g. local accounts).
        
        • Optionalallowed_domains?: string[]

          List of allowed domains. Users creating credentials or collections on this storage gateway must have an identity in one of these domains.

        • Optionalauthentication_assurance_timeout?: null | number

          Alias for authentication_timeout_mins

        • Optionalauthentication_timeout_mins?: null | number

          Timeout (in minutes) during which a user is required to have authenticated to access files or create user credentials on this storage gateway.

          For a high assurance storage gateway, this must be done within the
          current Globus Auth session, otherwise, the caller can perform the
          authentication with any application which uses Globus Auth.
          
        • Optionalconnector_id?: string

          Format: uuid

          Id of the connector type that this storage gateway interacts with.

        • DATA_TYPE: "storage_gateway#1.0.0"

          Type of this document

          storage_gateway#1.0.0
          @enum {string}
        • Optionaldeleted?: boolean

          Flag indicating that this storage gateway has been deleted

        • Optionaldisplay_name?: string

          Name of the storage gateway

        • Optionalhigh_assurance?: null | boolean

          Flag indicating if the storage_gateway requires high assurance features.

        • Optionalid?: string

          Format: uuid

          Unique id for this storage gateway

        • Optionalidentity_mappings?:
              | null
              | (
                  | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                  | {
                      DATA_TYPE: "expression_identity_mapping#1.0.0";
                      mappings?: {
                          ignore_case?: boolean;
                          literal?: boolean;
                          match?: string;
                          output?: string;
                          source?: string;
                      }[];
                  }
              )[]

          List of identity mappings to apply to user identities to determine what connector-specific accounts are available for access.

        • Optionalload_dsi_module?: null | string

          Name of the DSI module to load by the GridFTP server when accessing this storage gateway.

        • Optionalpolicies?:
              | {
                  DATA_TYPE: "s3_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.1.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.2.0";
                  s3_allow_multi_keys?: boolean;
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  bp_access_id_file?: string;
                  DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                  s3_endpoint?: string;
              }
              | {
                  boxAppSettings: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  DATA_TYPE: "box_storage_policies#1.0.0";
                  enterpriseID: string;
              }
              | {
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.1.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.2.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  ceph_admin_key_id?: string;
                  ceph_admin_secret_key?: string;
                  DATA_TYPE: "ceph_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "dropbox_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.1.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.0.0";
                  uda_checksum: boolean;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.1.0";
                  login_name?: string;
                  uda_checksum: boolean;
              }
              | {
                  DATA_TYPE: "irods_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  irods_authentication_file?: string;
                  irods_environment_file: string;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.0.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.1.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  DATA_TYPE: "posix_storage_policies#1.0.0";
                  groups_allow?: null
                  | string[];
                  groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  groups_allow?: null | string[];
                  groups_deny?: null | string[];
                  stage_app: string;
              }

          Connector-specific storage policies

        • Optionalprocess_user?: null | string

          Local POSIX user the GridFTP server should run as when accessing this storage gateway.

        • Optionalrequire_high_assurance?: null | boolean

          Alias for high_assurance

        • Optionalrestrict_paths?: unknown

          Path restrictions within this storage gateway. Paths are interpreted as absolute paths in the file namespace of the connector.

        • Optionalusers_allow?: null | string[]

          List of connector-specific usernames allowed to access this storage gateway.

        • Optionalusers_deny?: null | string[]

          List of connector-specific usernames denied access to this storage gateway.

      • StorageGateway_1_1_0: {
            allowed_domains?: string[];
            authentication_assurance_timeout?: null | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.1.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        }

        StorageGateway_1_1_0

        A storage gateway provides the access policies for the endpoint's connected storage systems. It is a named interface by which authorized users can create and manage collections on the connected storage system. A single storage system may be associated with multiple storage gateways, each with its own policies.

        Storage gateway policies describe what type connector the storage
        gateway uses, the paths it allows access to, the login
        requirements are for the storage gateway, and the algorithm to
        map Globus identities to the user namespace of the storage
        gateway (e.g. local accounts).
        
        Version 1.1.0 includes support for multi-factor authentication requirements
        for high assurance storage gateways.
        
        • Optionalallowed_domains?: string[]

          List of allowed domains. Users creating credentials or collections on this storage gateway must have an identity in one of these domains.

        • Optionalauthentication_assurance_timeout?: null | number

          Alias for authentication_timeout_mins

        • Optionalauthentication_timeout_mins?: null | number

          Timeout (in minutes) during which a user is required to have authenticated to access files or create user credentials on this storage gateway.

          For a high assurance storage gateway, this must be done within the
          current Globus Auth session, otherwise, the caller can perform the
          authentication with any application which uses Globus Auth.
          
        • Optionalconnector_id?: string

          Format: uuid

          Id of the connector type that this storage gateway interacts with.

        • DATA_TYPE: "storage_gateway#1.1.0"

          Type of this document

          storage_gateway#1.1.0
          @enum {string}
        • Optionaldeleted?: boolean

          Flag indicating that this storage gateway has been deleted

        • Optionaldisplay_name?: string

          Name of the storage gateway

        • Optionalhigh_assurance?: null | boolean

          Flag indicating if the storage_gateway requires high assurance features.

        • Optionalid?: string

          Format: uuid

          Unique id for this storage gateway

        • Optionalidentity_mappings?:
              | null
              | (
                  | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                  | {
                      DATA_TYPE: "expression_identity_mapping#1.0.0";
                      mappings?: {
                          ignore_case?: boolean;
                          literal?: boolean;
                          match?: string;
                          output?: string;
                          source?: string;
                      }[];
                  }
              )[]

          List of identity mappings to apply to user identities to determine what connector-specific accounts are available for access.

        • Optionalload_dsi_module?: null | string

          Name of the DSI module to load by the GridFTP server when accessing this storage gateway.

        • Optionalpolicies?:
              | {
                  DATA_TYPE: "s3_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.1.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.2.0";
                  s3_allow_multi_keys?: boolean;
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  bp_access_id_file?: string;
                  DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                  s3_endpoint?: string;
              }
              | {
                  boxAppSettings: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  DATA_TYPE: "box_storage_policies#1.0.0";
                  enterpriseID: string;
              }
              | {
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.1.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.2.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  ceph_admin_key_id?: string;
                  ceph_admin_secret_key?: string;
                  DATA_TYPE: "ceph_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "dropbox_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.1.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.0.0";
                  uda_checksum: boolean;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.1.0";
                  login_name?: string;
                  uda_checksum: boolean;
              }
              | {
                  DATA_TYPE: "irods_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  irods_authentication_file?: string;
                  irods_environment_file: string;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.0.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.1.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  DATA_TYPE: "posix_storage_policies#1.0.0";
                  groups_allow?: null
                  | string[];
                  groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  groups_allow?: null | string[];
                  groups_deny?: null | string[];
                  stage_app: string;
              }

          Connector-specific storage policies

        • Optionalprocess_user?: null | string

          Local POSIX user the GridFTP server should run as when accessing this storage gateway.

        • Optionalrequire_high_assurance?: null | boolean

          Alias for high_assurance

        • require_mfa: boolean

          Flag indicating if the storage_gateway requires multi-factor authentication. Only usable on high assurance storage gateways.

          false
          
        • Optionalrestrict_paths?: unknown

          Path restrictions within this storage gateway. Paths are interpreted as absolute paths in the file namespace of the connector.

        • Optionalusers_allow?: null | string[]

          List of connector-specific usernames allowed to access this storage gateway.

        • Optionalusers_deny?: null | string[]

          List of connector-specific usernames denied access to this storage gateway.

      • StorageGateway_1_2_0: {
            admin_managed_credentials: boolean;
            allowed_domains?: string[];
            authentication_assurance_timeout?: null | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.2.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        }

        StorageGateway_1_2_0

        A storage gateway provides the access policies for the endpoint's connected storage systems. It is a named interface by which authorized users can create and manage collections on the connected storage system. A single storage system may be associated with multiple storage gateways, each with its own policies.

        Storage gateway policies describe what type connector the storage
        gateway uses, the paths it allows access to, the login
        requirements are for the storage gateway, and the algorithm to
        map Globus identities to the user namespace of the storage
        gateway (e.g. local accounts).
        
        Version 1.1.0 includes support for multi-factor authentication requirements
        for high assurance storage gateways.
        
        Version 1.2.0 includes support for admin managed credentials.
        
        • admin_managed_credentials: boolean

          Flag indicating if the storage_gateway allows endpoint administrators to manage user credentials on behalf of other users.

          false
          
        • Optionalallowed_domains?: string[]

          List of allowed domains. Users creating credentials or collections on this storage gateway must have an identity in one of these domains.

        • Optionalauthentication_assurance_timeout?: null | number

          Alias for authentication_timeout_mins

        • Optionalauthentication_timeout_mins?: null | number

          Timeout (in minutes) during which a user is required to have authenticated to access files or create user credentials on this storage gateway.

          For a high assurance storage gateway, this must be done within the
          current Globus Auth session, otherwise, the caller can perform the
          authentication with any application which uses Globus Auth.
          
        • Optionalconnector_id?: string

          Format: uuid

          Id of the connector type that this storage gateway interacts with.

        • DATA_TYPE: "storage_gateway#1.2.0"

          Type of this document

          storage_gateway#1.2.0
          @enum {string}
        • Optionaldeleted?: boolean

          Flag indicating that this storage gateway has been deleted

        • Optionaldisplay_name?: string

          Name of the storage gateway

        • Optionalhigh_assurance?: null | boolean

          Flag indicating if the storage_gateway requires high assurance features.

        • Optionalid?: string

          Format: uuid

          Unique id for this storage gateway

        • Optionalidentity_mappings?:
              | null
              | (
                  | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                  | {
                      DATA_TYPE: "expression_identity_mapping#1.0.0";
                      mappings?: {
                          ignore_case?: boolean;
                          literal?: boolean;
                          match?: string;
                          output?: string;
                          source?: string;
                      }[];
                  }
              )[]

          List of identity mappings to apply to user identities to determine what connector-specific accounts are available for access.

        • Optionalload_dsi_module?: null | string

          Name of the DSI module to load by the GridFTP server when accessing this storage gateway.

        • Optionalpolicies?:
              | {
                  DATA_TYPE: "s3_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.1.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.2.0";
                  s3_allow_multi_keys?: boolean;
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  bp_access_id_file?: string;
                  DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                  s3_endpoint?: string;
              }
              | {
                  boxAppSettings: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  DATA_TYPE: "box_storage_policies#1.0.0";
                  enterpriseID: string;
              }
              | {
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.1.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.2.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  ceph_admin_key_id?: string;
                  ceph_admin_secret_key?: string;
                  DATA_TYPE: "ceph_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "dropbox_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.1.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.0.0";
                  uda_checksum: boolean;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.1.0";
                  login_name?: string;
                  uda_checksum: boolean;
              }
              | {
                  DATA_TYPE: "irods_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  irods_authentication_file?: string;
                  irods_environment_file: string;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.0.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.1.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  DATA_TYPE: "posix_storage_policies#1.0.0";
                  groups_allow?: null
                  | string[];
                  groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  groups_allow?: null | string[];
                  groups_deny?: null | string[];
                  stage_app: string;
              }

          Connector-specific storage policies

        • Optionalprocess_user?: null | string

          Local POSIX user the GridFTP server should run as when accessing this storage gateway.

        • Optionalrequire_high_assurance?: null | boolean

          Alias for high_assurance

        • require_mfa: boolean

          Flag indicating if the storage_gateway requires multi-factor authentication. Only usable on high assurance storage gateways.

          false
          
        • Optionalrestrict_paths?: unknown

          Path restrictions within this storage gateway. Paths are interpreted as absolute paths in the file namespace of the connector.

        • Optionalusers_allow?: null | string[]

          List of connector-specific usernames allowed to access this storage gateway.

        • Optionalusers_deny?: null | string[]

          List of connector-specific usernames denied access to this storage gateway.

      • StorageGateway_1_3_0: {
            admin_managed_credentials: boolean;
            allowed_domains?: string[];
            authentication_assurance_timeout?: null | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.3.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?:
                | null
                | (
                    | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                    | {
                        DATA_TYPE: "expression_identity_mapping#1.0.0";
                        mappings?: {
                            ignore_case?: boolean;
                            literal?: boolean;
                            match?: string;
                            output?: string;
                            source?: string;
                        }[];
                    }
                )[];
            load_dsi_module?: null
            | string;
            max_concurrency?: number;
            max_parallelism?: number;
            network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.2.0";
                    s3_allow_multi_keys?: boolean;
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                    s3_requester_pays?: boolean;
                    s3_user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    account: null
                    | string;
                    adls: null | boolean;
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    auth_type: null | string;
                    client_id: null | string;
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: null | string;
                    tenant: null | string;
                    user_credential_required?: boolean;
                }
                | {
                    bp_access_id_file?: string;
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: string;
                }
                | {
                    boxAppSettings: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    boxAppSettings?: {
                        appAuth: {
                            passphrase: string;
                            privateKey: string;
                            publicKeyID: string;
                        };
                        clientID: string;
                        clientSecret: string;
                    };
                    client_id?: string;
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: string;
                    secret?: string;
                    user_api_rate_limit?: number;
                    user_credential_required?: boolean;
                }
                | {
                    ceph_admin_key_id?: string;
                    ceph_admin_secret_key?: string;
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: string[];
                    s3_endpoint?: string;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    buckets?: null
                    | string[];
                    client_id: null | string;
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: null | string[];
                    secret: null | string;
                    service_account_key?: null | Record<string, unknown>;
                    user_credential_required?: boolean;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: null | string;
                    user_api_rate_quota?: number;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: "krb5"
                    | "unix";
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: string;
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    irods_authentication_file?: string;
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    allow_any_account?: boolean;
                    auth_callback?: string;
                    client_id: null
                    | string;
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: null | string;
                    tenant?: null | string;
                    user_api_rate_limit?: number;
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: null
                    | string[];
                    groups_deny?: null | string[];
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: { name: string; value: string }[];
                    groups_allow?: null | string[];
                    groups_deny?: null | string[];
                    stage_app: string;
                };
            preferred_concurrency?: number;
            preferred_parallelism?: number;
            process_user?: null
            | string;
            require_high_assurance?: null | boolean;
            require_mfa: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        }

        StorageGateway_1_3_0

        A storage gateway provides the access policies for the endpoint's connected storage systems. It is a named interface by which authorized users can create and manage collections on the connected storage system. A single storage system may be associated with multiple storage gateways, each with its own policies.

        Storage gateway policies describe what type connector the storage
        gateway uses, the paths it allows access to, the login
        requirements are for the storage gateway, and the algorithm to
        map Globus identities to the user namespace of the storage
        gateway (e.g. local accounts).
        
        Version 1.1.0 includes support for multi-factor authentication requirements
        for high assurance storage gateways.
        
        Version 1.2.0 includes support for admin managed credentials.
        
        Version 1.3.0 includes support for overriding the endpoint's network use
        parameters on a storage gateway.
        
        • admin_managed_credentials: boolean

          Flag indicating if the storage_gateway allows endpoint administrators to manage user credentials on behalf of other users.

          false
          
        • Optionalallowed_domains?: string[]

          List of allowed domains. Users creating credentials or collections on this storage gateway must have an identity in one of these domains.

        • Optionalauthentication_assurance_timeout?: null | number

          Alias for authentication_timeout_mins

        • Optionalauthentication_timeout_mins?: null | number

          Timeout (in minutes) during which a user is required to have authenticated to access files or create user credentials on this storage gateway.

          For a high assurance storage gateway, this must be done within the
          current Globus Auth session, otherwise, the caller can perform the
          authentication with any application which uses Globus Auth.
          
        • Optionalconnector_id?: string

          Format: uuid

          Id of the connector type that this storage gateway interacts with.

        • DATA_TYPE: "storage_gateway#1.3.0"

          Type of this document

          storage_gateway#1.3.0
          @enum {string}
        • Optionaldeleted?: boolean

          Flag indicating that this storage gateway has been deleted

        • Optionaldisplay_name?: string

          Name of the storage gateway

        • Optionalhigh_assurance?: null | boolean

          Flag indicating if the storage_gateway requires high assurance features.

        • Optionalid?: string

          Format: uuid

          Unique id for this storage gateway

        • Optionalidentity_mappings?:
              | null
              | (
                  | { command?: string[]; DATA_TYPE: "external_identity_mapping#1.0.0" }
                  | {
                      DATA_TYPE: "expression_identity_mapping#1.0.0";
                      mappings?: {
                          ignore_case?: boolean;
                          literal?: boolean;
                          match?: string;
                          output?: string;
                          source?: string;
                      }[];
                  }
              )[]

          List of identity mappings to apply to user identities to determine what connector-specific accounts are available for access.

        • Optionalload_dsi_module?: null | string

          Name of the DSI module to load by the GridFTP server when accessing this storage gateway.

        • Optionalmax_concurrency?: number

          Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

        • Optionalmax_parallelism?: number

          Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

        • Optionalnetwork_use?: null | "normal" | "minimal" | "aggressive" | "custom"

          Control how Globus interacts with this endpoint over the network.

          Allowed values for **network_use** are:
          
          * `normal`
              - The default setting. Uses an average level of concurrency and
                parallelism. The levels depend on the number of physical
                servers in the endpoint.
          * `minimal`
              - Uses a minimal level of concurrency and parallelism.
          * `aggressive`
              - Uses a high level of concurrency and parallelism.
          * `custom`
              - Uses custom values of concurrency and parallelism set by the
                endpoint admin. When setting this level, you must also set
                the **max_concurrency**, **preferred_concurrency**,
                **max_parallelism**, and **preferred_parallelism** properties.
          
        • Optionalpolicies?:
              | {
                  DATA_TYPE: "s3_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.1.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  DATA_TYPE: "s3_storage_policies#1.2.0";
                  s3_allow_multi_keys?: boolean;
                  s3_buckets?: string[];
                  s3_endpoint?: string;
                  s3_requester_pays?: boolean;
                  s3_user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  account: null
                  | string;
                  adls: null | boolean;
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  auth_type: null | string;
                  client_id: null | string;
                  DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                  secret: null | string;
                  tenant: null | string;
                  user_credential_required?: boolean;
              }
              | {
                  bp_access_id_file?: string;
                  DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                  s3_endpoint?: string;
              }
              | {
                  boxAppSettings: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  DATA_TYPE: "box_storage_policies#1.0.0";
                  enterpriseID: string;
              }
              | {
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.1.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  boxAppSettings?: {
                      appAuth: {
                          passphrase: string;
                          privateKey: string;
                          publicKeyID: string;
                      };
                      clientID: string;
                      clientSecret: string;
                  };
                  client_id?: string;
                  DATA_TYPE: "box_storage_policies#1.2.0";
                  enterpriseID?: string;
                  secret?: string;
                  user_api_rate_limit?: number;
                  user_credential_required?: boolean;
              }
              | {
                  ceph_admin_key_id?: string;
                  ceph_admin_secret_key?: string;
                  DATA_TYPE: "ceph_storage_policies#1.0.0";
                  s3_buckets?: string[];
                  s3_endpoint?: string;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "dropbox_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  buckets?: null
                  | string[];
                  client_id: null | string;
                  DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                  projects?: null | string[];
                  secret: null | string;
                  service_account_key?: null | Record<string, unknown>;
                  user_credential_required?: boolean;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.0.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "google_drive_storage_policies#1.1.0";
                  secret: null | string;
                  user_api_rate_quota?: number;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.0.0";
                  uda_checksum: boolean;
              }
              | {
                  authentication_mech: "krb5"
                  | "unix";
                  authenticator: string;
                  DATA_TYPE: "hpss_storage_policies#1.1.0";
                  login_name?: string;
                  uda_checksum: boolean;
              }
              | {
                  DATA_TYPE: "irods_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  irods_authentication_file?: string;
                  irods_environment_file: string;
              }
              | {
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.0.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  allow_any_account?: boolean;
                  auth_callback?: string;
                  client_id: null
                  | string;
                  DATA_TYPE: "onedrive_storage_policies#1.1.0";
                  secret: null | string;
                  tenant?: null | string;
                  user_api_rate_limit?: number;
              }
              | {
                  DATA_TYPE: "posix_storage_policies#1.0.0";
                  groups_allow?: null
                  | string[];
                  groups_deny?: null | string[];
              }
              | {
                  DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                  environment?: { name: string; value: string }[];
                  groups_allow?: null | string[];
                  groups_deny?: null | string[];
                  stage_app: string;
              }

          Connector-specific storage policies

        • Optionalpreferred_concurrency?: number

          Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

        • Optionalpreferred_parallelism?: number

          Admin-specified value when the network_use property's value is custom; otherwise the preset value for the specified network_use.

        • Optionalprocess_user?: null | string

          Local POSIX user the GridFTP server should run as when accessing this storage gateway.

        • Optionalrequire_high_assurance?: null | boolean

          Alias for high_assurance

        • require_mfa: boolean

          Flag indicating if the storage_gateway requires multi-factor authentication. Only usable on high assurance storage gateways.

          false
          
        • Optionalrestrict_paths?: unknown

          Path restrictions within this storage gateway. Paths are interpreted as absolute paths in the file namespace of the connector.

        • Optionalusers_allow?: null | string[]

          List of connector-specific usernames allowed to access this storage gateway.

        • Optionalusers_deny?: null | string[]

          List of connector-specific usernames denied access to this storage gateway.

      • StorageGatewayNotFound: { DATA_TYPE: "storage_gateway_not_found#1.0.0"; storage_gateway_id?: string }

        StorageGatewayNotFound

        Error details when a storage gateway no longer exists when accessing a collection.

        • DATA_TYPE: "storage_gateway_not_found#1.0.0"

          Type of this document

          storage_gateway_not_found#1.0.0
          @enum {string}
        • Optionalstorage_gateway_id?: string

          Format: uuid

          Storage gateway ID

      • StorageGatewayNotFound_1_0_0: { DATA_TYPE: "storage_gateway_not_found#1.0.0"; storage_gateway_id?: string }

        StorageGatewayNotFound_1_0_0

        Error details when a storage gateway no longer exists when accessing a collection.

        • DATA_TYPE: "storage_gateway_not_found#1.0.0"

          Type of this document

          storage_gateway_not_found#1.0.0
          @enum {string}
        • Optionalstorage_gateway_id?: string

          Format: uuid

          Storage gateway ID

      • SubscriptionAdminVerified: {
            DATA_TYPE: "subscription_admin_verified#1.0.0";
            subscription_admin_verified: boolean;
        }

        SubscriptionAdminVerified

        Subscription Admin Verified

        • DATA_TYPE: "subscription_admin_verified#1.0.0"

          Type of this document

          subscription_admin_verified#1.0.0
          @enum {string}
        • subscription_admin_verified: boolean

          Value of the subscription_admin_verified property of a collection. This can be set or cleared by a subscription group administrator.

      • SubscriptionAdminVerified_1_0_0: {
            DATA_TYPE: "subscription_admin_verified#1.0.0";
            subscription_admin_verified: boolean;
        }

        SubscriptionAdminVerified_1_0_0

        Subscription Admin Verified

        • DATA_TYPE: "subscription_admin_verified#1.0.0"

          Type of this document

          subscription_admin_verified#1.0.0
          @enum {string}
        • subscription_admin_verified: boolean

          Value of the subscription_admin_verified property of a collection. This can be set or cleared by a subscription group administrator.

      • SubscriptionRequired: {
            add_ons?: string[];
            DATA_TYPE: "subscription_required#1.0.0";
            subscription_level?: string;
        }

        SubscriptionRequired

        Error details when the caller has attempted to access a feature not supported by the endpoint's subscription.

        • Optionaladd_ons?: string[]

          List of subscription add-ons required for this feature

        • DATA_TYPE: "subscription_required#1.0.0"

          Type of this document

          subscription_required#1.0.0
          @enum {string}
        • Optionalsubscription_level?: string

          Level of subscription required for this feature

      • SubscriptionRequired_1_0_0: {
            add_ons?: string[];
            DATA_TYPE: "subscription_required#1.0.0";
            subscription_level?: string;
        }

        SubscriptionRequired_1_0_0

        Error details when the caller has attempted to access a feature not supported by the endpoint's subscription.

        • Optionaladd_ons?: string[]

          List of subscription add-ons required for this feature

        • DATA_TYPE: "subscription_required#1.0.0"

          Type of this document

          subscription_required#1.0.0
          @enum {string}
        • Optionalsubscription_level?: string

          Level of subscription required for this feature

      • UserCredential: {
            connector_id?: string;
            DATA_TYPE: "user_credential#1.0.0";
            deleted?: boolean;
            display_name?: null | string;
            home_directory?: string;
            id?: string;
            identity_id?: string;
            invalid?: boolean;
            policies?:
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.0.0";
                    s3_key_id?: null
                    | string;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.1.0";
                    s3_key_id?: null
                    | string;
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.2.0";
                    s3_key_id?: null
                    | string;
                    s3_multi_keys?:
                        | null
                        | {
                            path_prefixes: string[];
                            s3_key_id?: null
                            | string;
                            s3_secret_key?: null | string;
                        }[];
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null
                    | string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | {
                    access_id?: string;
                    DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                    secret_key?: string;
                }
                | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "box_user_credential_policies#1.1.0";
                    email?: null | string;
                    max_upload?: number;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    root_info?: Record<string, unknown>;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                    email?: string;
                    projects?: { name?: string; projectId?: string }[];
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
            provisioned?: boolean;
            storage_gateway_id?: string;
            username?: string;
        }

        UserCredential

        Credential information for an identity on a particular storage gateway and its related collections.

        • Optionalconnector_id?: string

          Format: uuid

          Id of the connector type used by this credential

        • DATA_TYPE: "user_credential#1.0.0"

          Type of this document

          user_credential#1.0.0
          @enum {string}
        • Optionaldeleted?: boolean

          Flag indicating that this credential has been deleted

        • Optionaldisplay_name?: null | string

          Display name of the credential

        • Optional Readonlyhome_directory?: string

          The home directory of this account associated with this credential

        • Optionalid?: string

          Format: uuid

          Unique id for this user credential

        • Optionalidentity_id?: string

          Format: uuid

          Globus Auth identity id that this credential is associated with

        • Optionalinvalid?: boolean

          Flag indicating that this credential is no longer valid

        • Optionalpolicies?:
              | {
                  DATA_TYPE: "s3_user_credential_policies#1.0.0";
                  s3_key_id?: null
                  | string;
                  s3_secret_key?: null | string;
              }
              | {
                  DATA_TYPE: "s3_user_credential_policies#1.1.0";
                  s3_key_id?: null
                  | string;
                  s3_requester_pays?: boolean;
                  s3_secret_key?: null | string;
              }
              | {
                  DATA_TYPE: "s3_user_credential_policies#1.2.0";
                  s3_key_id?: null
                  | string;
                  s3_multi_keys?:
                      | null
                      | {
                          path_prefixes: string[];
                          s3_key_id?: null
                          | string;
                          s3_secret_key?: null | string;
                      }[];
                  s3_requester_pays?: boolean;
                  s3_secret_key?: null
                  | string;
              }
              | {
                  access_token?: null
                  | string;
                  DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  tid?: string;
                  token_expiry?: string;
              }
              | {
                  access_id?: string;
                  DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                  secret_key?: string;
              }
              | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
              | {
                  access_token?: null | string;
                  DATA_TYPE: "box_user_credential_policies#1.1.0";
                  email?: null | string;
                  max_upload?: number;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  token_expiry?: string;
              }
              | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
              | {
                  access_token?: null | string;
                  DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  root_info?: Record<string, unknown>;
                  scopes?: string[];
                  sub?: null | string;
                  token_expiry?: string;
              }
              | {
                  access_token?: null
                  | string;
                  DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                  email?: string;
                  projects?: { name?: string; projectId?: string }[];
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: string;
                  token_expiry?: string;
              }
              | {
                  access_token?: null
                  | string;
                  DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  token_expiry?: string;
              }
              | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
              | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
              | {
                  access_token?: null | string;
                  DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  tid?: string;
                  token_expiry?: string;
              }
              | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
              | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" }

          Connector-specific user credential policies

        • Optionalprovisioned?: boolean

          Flag indicating that this credential has been fully provisioned. If this is false and the invalid property is true, then the credential was created during login and patching it to add the missing data should be presented to the user as initializing the credential.

        • Optionalstorage_gateway_id?: string

          Format: uuid

          Storage Gateway this credential is associated with

        • Optionalusername?: string

          Connector-specific username that this credential is associated with. If the connector supports identity mapping, this matches the result of the mapping applied to identity_id.

      • UserCredential_1_0_0: {
            connector_id?: string;
            DATA_TYPE: "user_credential#1.0.0";
            deleted?: boolean;
            display_name?: null | string;
            home_directory?: string;
            id?: string;
            identity_id?: string;
            invalid?: boolean;
            policies?:
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.0.0";
                    s3_key_id?: null
                    | string;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.1.0";
                    s3_key_id?: null
                    | string;
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null | string;
                }
                | {
                    DATA_TYPE: "s3_user_credential_policies#1.2.0";
                    s3_key_id?: null
                    | string;
                    s3_multi_keys?:
                        | null
                        | {
                            path_prefixes: string[];
                            s3_key_id?: null
                            | string;
                            s3_secret_key?: null | string;
                        }[];
                    s3_requester_pays?: boolean;
                    s3_secret_key?: null
                    | string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | {
                    access_id?: string;
                    DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                    secret_key?: string;
                }
                | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "box_user_credential_policies#1.1.0";
                    email?: null | string;
                    max_upload?: number;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    root_info?: Record<string, unknown>;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                    email?: string;
                    projects?: { name?: string; projectId?: string }[];
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: string;
                    token_expiry?: string;
                }
                | {
                    access_token?: null
                    | string;
                    DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
                | {
                    access_token?: null | string;
                    DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                    email?: null | string;
                    refresh_token?: null | string;
                    scopes?: string[];
                    sub?: null | string;
                    tid?: string;
                    token_expiry?: string;
                }
                | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
                | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
            provisioned?: boolean;
            storage_gateway_id?: string;
            username?: string;
        }

        UserCredential_1_0_0

        Credential information for an identity on a particular storage gateway and its related collections.

        • Optionalconnector_id?: string

          Format: uuid

          Id of the connector type used by this credential

        • DATA_TYPE: "user_credential#1.0.0"

          Type of this document

          user_credential#1.0.0
          @enum {string}
        • Optionaldeleted?: boolean

          Flag indicating that this credential has been deleted

        • Optionaldisplay_name?: null | string

          Display name of the credential

        • Optional Readonlyhome_directory?: string

          The home directory of this account associated with this credential

        • Optionalid?: string

          Format: uuid

          Unique id for this user credential

        • Optionalidentity_id?: string

          Format: uuid

          Globus Auth identity id that this credential is associated with

        • Optionalinvalid?: boolean

          Flag indicating that this credential is no longer valid

        • Optionalpolicies?:
              | {
                  DATA_TYPE: "s3_user_credential_policies#1.0.0";
                  s3_key_id?: null
                  | string;
                  s3_secret_key?: null | string;
              }
              | {
                  DATA_TYPE: "s3_user_credential_policies#1.1.0";
                  s3_key_id?: null
                  | string;
                  s3_requester_pays?: boolean;
                  s3_secret_key?: null | string;
              }
              | {
                  DATA_TYPE: "s3_user_credential_policies#1.2.0";
                  s3_key_id?: null
                  | string;
                  s3_multi_keys?:
                      | null
                      | {
                          path_prefixes: string[];
                          s3_key_id?: null
                          | string;
                          s3_secret_key?: null | string;
                      }[];
                  s3_requester_pays?: boolean;
                  s3_secret_key?: null
                  | string;
              }
              | {
                  access_token?: null
                  | string;
                  DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  tid?: string;
                  token_expiry?: string;
              }
              | {
                  access_id?: string;
                  DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
                  secret_key?: string;
              }
              | { DATA_TYPE: "box_user_credential_policies#1.0.0" }
              | {
                  access_token?: null | string;
                  DATA_TYPE: "box_user_credential_policies#1.1.0";
                  email?: null | string;
                  max_upload?: number;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  token_expiry?: string;
              }
              | { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
              | {
                  access_token?: null | string;
                  DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  root_info?: Record<string, unknown>;
                  scopes?: string[];
                  sub?: null | string;
                  token_expiry?: string;
              }
              | {
                  access_token?: null
                  | string;
                  DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
                  email?: string;
                  projects?: { name?: string; projectId?: string }[];
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: string;
                  token_expiry?: string;
              }
              | {
                  access_token?: null
                  | string;
                  DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  token_expiry?: string;
              }
              | { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
              | { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
              | {
                  access_token?: null | string;
                  DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
                  email?: null | string;
                  refresh_token?: null | string;
                  scopes?: string[];
                  sub?: null | string;
                  tid?: string;
                  token_expiry?: string;
              }
              | { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
              | { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" }

          Connector-specific user credential policies

        • Optionalprovisioned?: boolean

          Flag indicating that this credential has been fully provisioned. If this is false and the invalid property is true, then the credential was created during login and patching it to add the missing data should be presented to the user as initializing the credential.

        • Optionalstorage_gateway_id?: string

          Format: uuid

          Storage Gateway this credential is associated with

        • Optionalusername?: string

          Connector-specific username that this credential is associated with. If the connector supports identity mapping, this matches the result of the mapping applied to identity_id.