Function update

See

https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Collections/#putCollection

  • update(configuration, collection_id, options, sdkOptions?): Promise<JSONFetchResponse<{
        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;
    }>>

  • Parameters

    • configuration: GCSConfiguration
    • collection_id: string
    • options: undefined | {
          payload:
              | {
                  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;
              };
      } & {
          headers?: Headers;
          query?: {
              [key: string]:
                  | string
                  | number
                  | boolean
                  | (
                      | string
                      | number
                      | null
                      | undefined)[]
                  | null
                  | undefined;
          };
      }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<JSONFetchResponse<{
        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;
    }>>

Settings

Member Visibility