- get(configuration, collection_id, options?, sdkOptions?): Promise<JSONFetchResponse<{
code?: "success";
data?: ({
DATA_TYPE: "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;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
} | {
DATA_TYPE: "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;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
} | {
DATA_TYPE: "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;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
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?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
})[];
} & {
DATA_TYPE: "result#1.0.0";
code: string;
data?: Record<string, never>[];
detail?: Record<string, never>;
has_next_page?: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}>> Parameters
collection_id: string
Optional
options: {
query?: {
include?: "private_policies"[];
};
} & {
headers?: Headers;
query?: {
[key: string]: string | number | (string | number | null | undefined)[] | null | undefined;
};
}
Optional
sdkOptions: SDKOptions
Returns Promise<JSONFetchResponse<{
code?: "success";
data?: ({
DATA_TYPE: "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;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
} | {
DATA_TYPE: "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;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
} | {
DATA_TYPE: "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;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
} | {
DATA_TYPE: "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;
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?: {
DATA_TYPE: "domain#1.0.0";
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
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: "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: "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[];
} | {
DATA_TYPE: "s3_collection_policies#1.0.0";
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
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;
})[];
} & {
DATA_TYPE: "result#1.0.0";
code: string;
data?: Record<string, never>[];
detail?: Record<string, never>;
has_next_page?: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}>>
See
https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Collections/#getCollection