- get(configuration, storage_gateway_id, options?, sdkOptions?): Promise<JSONFetchResponse<{
code?: "success";
data?: ({
DATA_TYPE: "storage_gateway#1.0.0";
allowed_domains?: string[];
authentication_assurance_timeout?: null | number;
authentication_timeout_mins?: null | number;
connector_id?: string;
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?: null | ({
DATA_TYPE: "external_identity_mapping#1.0.0";
command?: string[];
} | {
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: "azure_blob_storage_policies#1.0.0";
account: null | string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
} | {
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
bp_access_id_file?: string;
s3_endpoint?: string;
} | {
DATA_TYPE: "box_storage_policies#1.0.0";
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
enterpriseID: string;
} | {
DATA_TYPE: "box_storage_policies#1.1.0";
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
} | {
DATA_TYPE: "ceph_storage_policies#1.0.0";
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
s3_buckets?: string[];
s3_endpoint?: string;
} | {
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
auth_callback?: string;
buckets?: null | string[];
client_id: null | string;
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
} | {
DATA_TYPE: "google_drive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
secret: null | string;
user_api_rate_quota?: number;
} | {
DATA_TYPE: "hpss_storage_policies#1.0.0";
authentication_mech: "krb5" | "unix";
authenticator: 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;
} | {
DATA_TYPE: "onedrive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
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;
} | {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
};
process_user?: null | string;
require_high_assurance?: null | boolean;
restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users_allow?: null | string[];
users_deny?: null | string[];
} | {
DATA_TYPE: "storage_gateway#1.1.0";
allowed_domains?: string[];
authentication_assurance_timeout?: null | number;
authentication_timeout_mins?: null | number;
connector_id?: string;
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?: null | ({
DATA_TYPE: "external_identity_mapping#1.0.0";
command?: string[];
} | {
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: "azure_blob_storage_policies#1.0.0";
account: null | string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
} | {
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
bp_access_id_file?: string;
s3_endpoint?: string;
} | {
DATA_TYPE: "box_storage_policies#1.0.0";
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
enterpriseID: string;
} | {
DATA_TYPE: "box_storage_policies#1.1.0";
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
} | {
DATA_TYPE: "ceph_storage_policies#1.0.0";
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
s3_buckets?: string[];
s3_endpoint?: string;
} | {
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
auth_callback?: string;
buckets?: null | string[];
client_id: null | string;
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
} | {
DATA_TYPE: "google_drive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
secret: null | string;
user_api_rate_quota?: number;
} | {
DATA_TYPE: "hpss_storage_policies#1.0.0";
authentication_mech: "krb5" | "unix";
authenticator: 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;
} | {
DATA_TYPE: "onedrive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
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;
} | {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
};
process_user?: null | string;
require_high_assurance?: null | boolean;
require_mfa?: boolean;
restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users_allow?: null | string[];
users_deny?: null | string[];
} | {
DATA_TYPE: "storage_gateway#1.2.0";
admin_managed_credentials?: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null | number;
authentication_timeout_mins?: null | number;
connector_id?: string;
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?: null | ({
DATA_TYPE: "external_identity_mapping#1.0.0";
command?: string[];
} | {
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: "azure_blob_storage_policies#1.0.0";
account: null | string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
} | {
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
bp_access_id_file?: string;
s3_endpoint?: string;
} | {
DATA_TYPE: "box_storage_policies#1.0.0";
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
enterpriseID: string;
} | {
DATA_TYPE: "box_storage_policies#1.1.0";
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
} | {
DATA_TYPE: "ceph_storage_policies#1.0.0";
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
s3_buckets?: string[];
s3_endpoint?: string;
} | {
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
auth_callback?: string;
buckets?: null | string[];
client_id: null | string;
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
} | {
DATA_TYPE: "google_drive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
secret: null | string;
user_api_rate_quota?: number;
} | {
DATA_TYPE: "hpss_storage_policies#1.0.0";
authentication_mech: "krb5" | "unix";
authenticator: 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;
} | {
DATA_TYPE: "onedrive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
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;
} | {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
};
process_user?: null | string;
require_high_assurance?: null | boolean;
require_mfa?: boolean;
restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users_allow?: null | string[];
users_deny?: 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
storage_gateway_id: string
Optional
options: {
query?: {
include?: ("private_policies" | "accounts")[];
};
} & {
headers?: Headers;
query?: {
[key: string]: string | number | (string | number | null | undefined)[] | null | undefined;
};
}
Optional
sdkOptions: SDKOptions
Returns Promise<JSONFetchResponse<{
code?: "success";
data?: ({
DATA_TYPE: "storage_gateway#1.0.0";
allowed_domains?: string[];
authentication_assurance_timeout?: null | number;
authentication_timeout_mins?: null | number;
connector_id?: string;
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?: null | ({
DATA_TYPE: "external_identity_mapping#1.0.0";
command?: string[];
} | {
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: "azure_blob_storage_policies#1.0.0";
account: null | string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
} | {
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
bp_access_id_file?: string;
s3_endpoint?: string;
} | {
DATA_TYPE: "box_storage_policies#1.0.0";
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
enterpriseID: string;
} | {
DATA_TYPE: "box_storage_policies#1.1.0";
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
} | {
DATA_TYPE: "ceph_storage_policies#1.0.0";
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
s3_buckets?: string[];
s3_endpoint?: string;
} | {
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
auth_callback?: string;
buckets?: null | string[];
client_id: null | string;
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
} | {
DATA_TYPE: "google_drive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
secret: null | string;
user_api_rate_quota?: number;
} | {
DATA_TYPE: "hpss_storage_policies#1.0.0";
authentication_mech: "krb5" | "unix";
authenticator: 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;
} | {
DATA_TYPE: "onedrive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
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;
} | {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
};
process_user?: null | string;
require_high_assurance?: null | boolean;
restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users_allow?: null | string[];
users_deny?: null | string[];
} | {
DATA_TYPE: "storage_gateway#1.1.0";
allowed_domains?: string[];
authentication_assurance_timeout?: null | number;
authentication_timeout_mins?: null | number;
connector_id?: string;
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?: null | ({
DATA_TYPE: "external_identity_mapping#1.0.0";
command?: string[];
} | {
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: "azure_blob_storage_policies#1.0.0";
account: null | string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
} | {
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
bp_access_id_file?: string;
s3_endpoint?: string;
} | {
DATA_TYPE: "box_storage_policies#1.0.0";
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
enterpriseID: string;
} | {
DATA_TYPE: "box_storage_policies#1.1.0";
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
} | {
DATA_TYPE: "ceph_storage_policies#1.0.0";
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
s3_buckets?: string[];
s3_endpoint?: string;
} | {
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
auth_callback?: string;
buckets?: null | string[];
client_id: null | string;
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
} | {
DATA_TYPE: "google_drive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
secret: null | string;
user_api_rate_quota?: number;
} | {
DATA_TYPE: "hpss_storage_policies#1.0.0";
authentication_mech: "krb5" | "unix";
authenticator: 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;
} | {
DATA_TYPE: "onedrive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
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;
} | {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
};
process_user?: null | string;
require_high_assurance?: null | boolean;
require_mfa?: boolean;
restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users_allow?: null | string[];
users_deny?: null | string[];
} | {
DATA_TYPE: "storage_gateway#1.2.0";
admin_managed_credentials?: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null | number;
authentication_timeout_mins?: null | number;
connector_id?: string;
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?: null | ({
DATA_TYPE: "external_identity_mapping#1.0.0";
command?: string[];
} | {
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: "azure_blob_storage_policies#1.0.0";
account: null | string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
} | {
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
bp_access_id_file?: string;
s3_endpoint?: string;
} | {
DATA_TYPE: "box_storage_policies#1.0.0";
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
enterpriseID: string;
} | {
DATA_TYPE: "box_storage_policies#1.1.0";
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
} | {
DATA_TYPE: "ceph_storage_policies#1.0.0";
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
s3_buckets?: string[];
s3_endpoint?: string;
} | {
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
auth_callback?: string;
buckets?: null | string[];
client_id: null | string;
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
} | {
DATA_TYPE: "google_drive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
secret: null | string;
user_api_rate_quota?: number;
} | {
DATA_TYPE: "hpss_storage_policies#1.0.0";
authentication_mech: "krb5" | "unix";
authenticator: 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;
} | {
DATA_TYPE: "onedrive_storage_policies#1.0.0";
auth_callback?: string;
client_id: null | string;
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;
} | {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
};
process_user?: null | string;
require_high_assurance?: null | boolean;
require_mfa?: boolean;
restrict_paths?: null | Record<string, unknown> | {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users_allow?: null | string[];
users_deny?: 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_Storage_Gateways/#getStorageGateway