checkCollection
checkCollection: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
DATA_TYPE: "check_result#1.0.0";
error?: null
| Record<(...), (...)>;
id?: string;
message?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
checkCollections
checkCollections: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: {
filter?: string[];
mapped_collection_id?: string;
marker?: string;
page_size?: number;
storage_gateway_id?: string;
};
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
DATA_TYPE: "check_result#1.0.0";
error?: null
| Record<(...), (...)>;
id?: string;
message?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteCollection
deleteCollection: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteCollectionDomain
deleteCollectionDomain: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteCollectionOwnerString
deleteCollectionOwnerString: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteEndpointDomain
deleteEndpointDomain: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteEndpointOwnerString
deleteEndpointOwnerString: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteNode
deleteNode: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { node_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteRole
deleteRole: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { role_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": | (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "subscription_required" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "subscription_required#1.0.0"; add_ons?: string[] | undefined; subscription_level?: string | undefined; } | undefined; } & ({ ...; } | { ...; })
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"409": {
content: {
"application/json": { code?: "conflict"; http_response_code?: 409 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteSharingPolicy
deleteSharingPolicy: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { sharing_policy_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteStorageGateway: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { storage_gateway_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
deleteUserCredential
deleteUserCredential: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { user_credential_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getAuthcallback
getAuthcallback: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query: { code?: string; error?: string; state: string };
};
requestBody?: undefined;
responses: {
"302": { content?: undefined; headers: { [name: string]: unknown } };
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getAuthcallbackGoogle
getAuthcallbackGoogle: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query: { code?: string; error?: string; state: string };
};
requestBody?: undefined;
responses: {
"302": { content?: undefined; headers: { [name: string]: unknown } };
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getAuthclicomplete
getAuthclicomplete: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { user_credential_id?: string };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
};
}
getCollection
getCollection: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: { include?: "private_policies"[] };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.0.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.1.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.2.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.3.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.4.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.5.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.6.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.7.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.8.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.9.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.10.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.11.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.12.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.13.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.14.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
associated_flow_policy?: unknown;
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.15.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getCollectionDomain
getCollectionDomain: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
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;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getEndpoint
getEndpoint: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.0.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.1.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.2.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
earliest_last_access?: (...) | (...);
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getEndpointDomain
getEndpointDomain: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getInfo
getInfo: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { marker?: string; page_size?: number };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "connector#1.0.0";
display_name: string;
id: string;
version?: (...)
| (...);
}
| {
DATA_TYPE: "connector#1.1.0";
display_name: string;
id: string;
is_baa?: (...)
| (...)
| (...);
is_ha?: (...) | (...) | (...);
version?: (...) | (...);
}
| {
api_version?: (...)
| (...);
client_id?: (...) | (...);
DATA_TYPE: "info#1.0.0";
domain_name?: (...) | (...);
endpoint_id?: (...) | (...);
manager_version?: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getNode
getNode: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { node_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getRole
getRole: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { role_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
collection?: null
| string;
DATA_TYPE: "role#1.0.0";
id?: string;
principal: string;
role:
| "owner"
| "administrator"
| "access_manager"
| "activity_manager"
| "activity_monitor"
| "access_monitor";
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getSharingPolicy
getSharingPolicy: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { sharing_policy_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
collection_id: string;
DATA_TYPE: "sharing_policy#1.0.0";
id?: string;
sharing_restrict_paths: {
DATA_TYPE: "path_restrictions#1.0.0";
none?: (...)
| (...);
read?: (...) | (...);
read_write?: (...) | (...);
};
users?: (...)[];
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getStorageGateway: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { storage_gateway_id: string };
query?: { include?: ("private_policies" | "accounts")[] };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
getUserCredential
getUserCredential: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { user_credential_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
listCollections
listCollections: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: {
filter?: string[];
include?: "private_policies"[];
mapped_collection_id?: string;
marker?: string;
page_size?: number;
storage_gateway_id?: string;
};
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.0.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.1.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.2.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.3.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.4.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.5.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.6.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.7.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.8.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.9.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.10.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.11.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.12.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.13.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.14.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
associated_flow_policy?: unknown;
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.15.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
listNodes
listNodes: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { marker?: string; page_size?: number };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
listRoles
listRoles: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: {
collection_id?: string;
include?: "all_roles"[];
marker?: string;
page_size?: number;
};
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
collection?: null
| string;
DATA_TYPE: "role#1.0.0";
id?: string;
principal: string;
role:
| "owner"
| "administrator"
| "access_manager"
| "activity_manager"
| "activity_monitor"
| "access_monitor";
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
listSharingPolicies
listSharingPolicies: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query: {
collection_id: string;
marker?: string;
page_size?: number;
username?: string;
};
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
collection_id: string;
DATA_TYPE: "sharing_policy#1.0.0";
id?: string;
sharing_restrict_paths: {
DATA_TYPE: "path_restrictions#1.0.0";
none?: (...)
| (...);
read?: (...) | (...);
read_write?: (...) | (...);
};
users?: (...)[];
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
listStorageGateways: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: {
include?: ("private_policies" | "accounts")[];
marker?: string;
page_size?: number;
};
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
listUserCredentials
listUserCredentials: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: {
include?: "all"[];
marker?: string;
page_size?: number;
storage_gateway?: string;
};
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
patchCollection
patchCollection: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": | {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.0.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.1.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null
| string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.2.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.3.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.4.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.5.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.6.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.7.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.8.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.9.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.10.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.11.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.12.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null | number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.13.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.14.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
associated_flow_policy?: unknown;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.15.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { collection_id: string }
Optionalquery?: undefined
requestBody: {
content: {
"application/json":
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.0.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.1.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null
| string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.2.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.3.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.4.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.5.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.6.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.7.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.8.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.9.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.10.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.11.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.12.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null | number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.13.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.14.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
associated_flow_policy?: unknown;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.15.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
patchEndpoint
patchEndpoint: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { include?: "endpoint"[] };
};
requestBody: {
content: {
"application/json": | {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.0.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.1.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.2.0";
department?: string;
description?: string;
display_name: string;
earliest_last_access?: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.0.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.1.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.2.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
earliest_last_access?: (...) | (...);
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { include?: "endpoint"[] };
}
Optionalcookie?: undefined
Optionalheader?: undefined
Optionalpath?: undefined
Optionalquery?: { include?: "endpoint"[] }
Optionalinclude?: "endpoint"[]
requestBody: {
content: {
"application/json":
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.0.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.1.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.2.0";
department?: string;
description?: string;
display_name: string;
earliest_last_access?: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.0.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.1.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.2.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
earliest_last_access?: (...) | (...);
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.0.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.1.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.2.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
earliest_last_access?: (...) | (...);
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
patchNode
patchNode: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { node_id: string };
query?: { include?: "node"[] };
};
requestBody: {
content: {
"application/json": | {
DATA_TYPE: "node#1.0.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active"
| "inactive";
}
| {
data_interface?: null
| string;
DATA_TYPE: "node#1.1.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
}
| {
data_interface?: null
| string;
data_interface6?: null | string;
DATA_TYPE: "node#1.2.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { node_id: string };
query?: { include?: "node"[] };
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { node_id: string }
Optionalquery?: { include?: "node"[] }
Optionalinclude?: "node"[]
requestBody: {
content: {
"application/json":
| {
DATA_TYPE: "node#1.0.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active"
| "inactive";
}
| {
data_interface?: null
| string;
DATA_TYPE: "node#1.1.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
}
| {
data_interface?: null
| string;
data_interface6?: null | string;
DATA_TYPE: "node#1.2.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
patchStorageGateway: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { storage_gateway_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": | {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
max_concurrency?: number;
max_parallelism?: number;
network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
preferred_concurrency?: number;
preferred_parallelism?: number;
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { storage_gateway_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { storage_gateway_id: string }
storage_gateway_id: string
Optionalquery?: undefined
requestBody: {
content: {
"application/json":
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
max_concurrency?: number;
max_parallelism?: number;
network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
preferred_concurrency?: number;
preferred_parallelism?: number;
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
patchUserCredential
patchUserCredential: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { user_credential_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| {
DATA_TYPE: "s3_user_credential_policies#1.0.0";
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.1.0";
s3_key_id?: null
| string;
s3_requester_pays?: boolean;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.2.0";
s3_key_id?: null
| string;
s3_multi_keys?:
| null
| {
path_prefixes: string[];
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}[];
s3_requester_pays?: boolean;
s3_secret_key?: null
| string;
}
| {
access_token?: null
| string;
DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| {
access_id?: string;
DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
secret_key?: string;
}
| { DATA_TYPE: "box_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "box_user_credential_policies#1.1.0";
email?: null | string;
max_upload?: number;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
root_info?: Record<string, unknown>;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
email?: string;
projects?: { name?: string; projectId?: string }[];
refresh_token?: null | string;
scopes?: string[];
sub?: string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
| { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
| { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { user_credential_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { user_credential_id: string }
user_credential_id: string
Optionalquery?: undefined
requestBody: {
content: {
"application/json": {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| {
DATA_TYPE: "s3_user_credential_policies#1.0.0";
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.1.0";
s3_key_id?: null
| string;
s3_requester_pays?: boolean;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.2.0";
s3_key_id?: null
| string;
s3_multi_keys?:
| null
| {
path_prefixes: string[];
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}[];
s3_requester_pays?: boolean;
s3_secret_key?: null
| string;
}
| {
access_token?: null
| string;
DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| {
access_id?: string;
DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
secret_key?: string;
}
| { DATA_TYPE: "box_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "box_user_credential_policies#1.1.0";
email?: null | string;
max_upload?: number;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
root_info?: Record<string, unknown>;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
email?: string;
projects?: { name?: string; projectId?: string }[];
refresh_token?: null | string;
scopes?: string[];
sub?: string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
| { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
| { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: string
| { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?: string | { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postCollection
postCollection: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": | {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.0.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.1.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null
| string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.2.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.3.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.4.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.5.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.6.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.7.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.8.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.9.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.10.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.11.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.12.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null | number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.13.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.14.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
associated_flow_policy?: unknown;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.15.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
};
};
};
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.0.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.1.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.2.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.3.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.4.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.5.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.6.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.7.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.8.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.9.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.10.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.11.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.12.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.13.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.14.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
associated_flow_policy?: unknown;
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.15.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "authentication_timeout#1.0.0";
high_assurance?: boolean;
identities?: string[];
}
| {
DATA_TYPE: "authentication_timeout#1.1.0";
high_assurance?: boolean;
identities?: string[];
require_mfa?: boolean;
}
| {
accounts: {
DATA_TYPE: "account#1.0.0";
identity_id?: (...)
| (...);
storage_gateway_id?: (...) | (...);
username?: (...) | (...);
}[];
DATA_TYPE: "credential_not_found#1.0.0";
}
| { DATA_TYPE: "id_not_in_identity_set#1.0.0"; id?: string }
| { DATA_TYPE: "invalid_credential#1.0.0"; user_credential_id: string }
| { DATA_TYPE: "invalid_user#1.0.0"; usernames?: string[] }
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
}
| {
allowed_domains?: string[];
DATA_TYPE: "not_from_allowed_domain#1.0.0";
}
| {
add_ons?: string[];
DATA_TYPE: "subscription_required#1.0.0";
subscription_level?: string;
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"409": {
content: {
"application/json": {
code?: "conflict";
detail?: | string
| { DATA_TYPE: "resource_conflict#1.0.0"; resources?: string[] };
http_response_code?: 409;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json":
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.0.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.1.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null
| string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.2.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.3.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.4.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.5.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.6.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.7.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.8.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.9.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.10.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.11.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.12.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null | number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.13.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.14.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
associated_flow_policy?: unknown;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.15.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
};
};
}
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.0.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.1.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.2.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.3.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.4.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.5.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.6.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.7.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.8.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.9.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.10.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.11.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.12.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.13.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.14.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
associated_flow_policy?: unknown;
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.15.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "authentication_timeout#1.0.0";
high_assurance?: boolean;
identities?: string[];
}
| {
DATA_TYPE: "authentication_timeout#1.1.0";
high_assurance?: boolean;
identities?: string[];
require_mfa?: boolean;
}
| {
accounts: {
DATA_TYPE: "account#1.0.0";
identity_id?: (...)
| (...);
storage_gateway_id?: (...) | (...);
username?: (...) | (...);
}[];
DATA_TYPE: "credential_not_found#1.0.0";
}
| { DATA_TYPE: "id_not_in_identity_set#1.0.0"; id?: string }
| { DATA_TYPE: "invalid_credential#1.0.0"; user_credential_id: string }
| { DATA_TYPE: "invalid_user#1.0.0"; usernames?: string[] }
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
}
| {
allowed_domains?: string[];
DATA_TYPE: "not_from_allowed_domain#1.0.0";
}
| {
add_ons?: string[];
DATA_TYPE: "subscription_required#1.0.0";
subscription_level?: string;
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"409": {
content: {
"application/json": {
code?: "conflict";
detail?: | string
| { DATA_TYPE: "resource_conflict#1.0.0"; resources?: string[] };
http_response_code?: 409;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
201: {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.0.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.1.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.2.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.3.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.4.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.5.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.6.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.7.0";
default_directory?: (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
DATA_TYPE: "collection#1.8.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
allow_guest_collections?: (...)
| (...)
| (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.9.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.10.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.11.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.12.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.13.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.14.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
| {
acl_expiration_mins?: (...)
| (...)
| (...);
activity_notification_policy?: (...) | (...);
allow_guest_collections?: (...) | (...) | (...);
associated_flow_policy?: unknown;
authentication_timeout_mins?: (...) | (...);
auto_delete_timeout?: (...) | (...) | (...);
collection_base_path: string;
collection_type: (...) | (...);
connector_id?: (...) | (...);
contact_email?: (...) | (...) | (...);
contact_info?: (...) | (...) | (...);
created_at?: (...) | (...) | (...);
DATA_TYPE: "collection#1.15.0";
default_directory?: (...) | (...);
delete_protected?: (...) | (...) | (...);
deleted?: (...) | (...) | (...);
department?: (...) | (...) | (...);
description?: (...) | (...) | (...);
disable_anonymous_writes?: (...) | (...) | (...);
disable_verify?: (...) | (...) | (...);
display_name: string;
domain?: (...) | (...);
domain_name?: (...) | (...);
enable_https?: (...) | (...) | (...);
force_encryption?: (...) | (...) | (...);
force_verify?: (...) | (...) | (...);
guest_auth_policy_id?: (...) | (...) | (...);
high_assurance?: (...) | (...) | (...);
https_url?: (...) | (...);
id?: (...) | (...);
identity_id?: (...) | (...);
info_link?: (...) | (...) | (...);
keywords?: (...) | (...);
last_access?: (...) | (...) | (...);
manager_url?: (...) | (...);
mapped_collection_id?: (...) | (...);
organization?: (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
public: boolean;
require_mfa?: (...) | (...) | (...);
restrict_transfers_to_high_assurance?:
| (...)
| (...)
| (...)
| (...)
| (...);
root_path?: (...) | (...);
sharing_restrict_paths?: unknown;
sharing_users_allow?: (...) | (...) | (...);
sharing_users_deny?: (...) | (...) | (...);
skip_auto_delete?: (...) | (...) | (...);
storage_gateway_id?: (...) | (...);
subscription_admin_verified?: (...) | (...) | (...);
tlsftp_url?: (...) | (...);
user_credential_id?: (...) | (...);
user_message?: (...) | (...) | (...);
user_message_link?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "authentication_timeout#1.0.0";
high_assurance?: boolean;
identities?: string[];
}
| {
DATA_TYPE: "authentication_timeout#1.1.0";
high_assurance?: boolean;
identities?: string[];
require_mfa?: boolean;
}
| {
accounts: {
DATA_TYPE: "account#1.0.0";
identity_id?: (...)
| (...);
storage_gateway_id?: (...) | (...);
username?: (...) | (...);
}[];
DATA_TYPE: "credential_not_found#1.0.0";
}
| { DATA_TYPE: "id_not_in_identity_set#1.0.0"; id?: string }
| { DATA_TYPE: "invalid_credential#1.0.0"; user_credential_id: string }
| { DATA_TYPE: "invalid_user#1.0.0"; usernames?: string[] }
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
}
| {
allowed_domains?: string[];
DATA_TYPE: "not_from_allowed_domain#1.0.0";
}
| {
add_ons?: string[];
DATA_TYPE: "subscription_required#1.0.0";
subscription_level?: string;
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
409: {
content: {
"application/json": {
code?: "conflict";
detail?:
| string
| { DATA_TYPE: "resource_conflict#1.0.0"; resources?: string[] };
http_response_code?: 409;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postCollectionsBatchDelete
postCollectionsBatchDelete: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": { DATA_TYPE: "batch#1.0.0"; ids?: string[] };
};
};
responses: {
"202": {
content: {
"application/json": {
code?: "success";
data?: { DATA_TYPE: "batch#1.0.0"; ids?: (...)[] }[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": | (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "batch#1.0.0"; ids?: string[] | undefined; } | undefined; } & ({ DATA_TYPE: "result#1.0.0"; ... 6 more ...; message?: string | undefined; } | { ...; })
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json": { DATA_TYPE: "batch#1.0.0"; ids?: string[] };
};
}
responses: {
"202": {
content: {
"application/json": {
code?: "success";
data?: { DATA_TYPE: "batch#1.0.0"; ids?: (...)[] }[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": | (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "batch#1.0.0"; ids?: string[] | undefined; } | undefined; } & ({ DATA_TYPE: "result#1.0.0"; ... 6 more ...; message?: string | undefined; } | { ...; })
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
202: {
content: {
"application/json": {
code?: "success";
data?: { DATA_TYPE: "batch#1.0.0"; ids?: (...)[] }[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json":
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "batch#1.0.0"; ids?: string[] | undefined; } | undefined; } & ({ DATA_TYPE: "result#1.0.0"; ... 6 more ...; message?: string | undefined; } | { ...; })
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postNode
postNode: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": | {
DATA_TYPE: "node#1.0.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active"
| "inactive";
}
| {
data_interface?: null
| string;
DATA_TYPE: "node#1.1.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
}
| {
data_interface?: null
| string;
data_interface6?: null | string;
DATA_TYPE: "node#1.2.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": | (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "limit_exceeded#1.0.0"; } | undefined; } & ({ DATA_TYPE: "result#1.0.0"; ... 6 more ...; message?: string | undefined; } | { ...; })
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json":
| {
DATA_TYPE: "node#1.0.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active"
| "inactive";
}
| {
data_interface?: null
| string;
DATA_TYPE: "node#1.1.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
}
| {
data_interface?: null
| string;
data_interface6?: null | string;
DATA_TYPE: "node#1.2.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": | (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "limit_exceeded#1.0.0"; } | undefined; } & ({ DATA_TYPE: "result#1.0.0"; ... 6 more ...; message?: string | undefined; } | { ...; })
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json":
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "limit_exceeded#1.0.0"; } | undefined; } & ({ DATA_TYPE: "result#1.0.0"; ... 6 more ...; message?: string | undefined; } | { ...; })
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postRoles
postRoles: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
collection?: null
| string;
DATA_TYPE: "role#1.0.0";
id?: string;
principal: string;
role:
| "owner"
| "administrator"
| "access_manager"
| "activity_manager"
| "activity_monitor"
| "access_monitor";
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
collection?: null
| string;
DATA_TYPE: "role#1.0.0";
id?: string;
principal: string;
role:
| "owner"
| "administrator"
| "access_manager"
| "activity_manager"
| "activity_monitor"
| "access_monitor";
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": | (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "subscription_required" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "subscription_required#1.0.0"; add_ons?: string[] | undefined; subscription_level?: string | undefined; } | undefined; } & ({ ...; } | { ...; })
);
};
headers: { [name: string]: unknown };
};
"409": {
content: {
"application/json": { code?: "exists"; http_response_code?: 409 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json": {
collection?: null | string;
DATA_TYPE: "role#1.0.0";
id?: string;
principal: string;
role:
| "owner"
| "administrator"
| "access_manager"
| "activity_manager"
| "activity_monitor"
| "access_monitor";
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
collection?: null | string;
DATA_TYPE: "role#1.0.0";
id?: string;
principal: string;
role:
| "owner"
| "administrator"
| "access_manager"
| "activity_manager"
| "activity_monitor"
| "access_monitor";
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": | (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "subscription_required" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "subscription_required#1.0.0"; add_ons?: string[] | undefined; subscription_level?: string | undefined; } | undefined; } & ({ ...; } | { ...; })
);
};
headers: { [name: string]: unknown };
};
"409": {
content: {
"application/json": { code?: "exists"; http_response_code?: 409 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: {
collection?: null | string;
DATA_TYPE: "role#1.0.0";
id?: string;
principal: string;
role:
| "owner"
| "administrator"
| "access_manager"
| "activity_manager"
| "activity_monitor"
| "access_monitor";
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json":
| (
{ code?: "permission_denied" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "missing_required_role#1.0.0"; roles?: { collection?: string | undefined; role: "owner" | ... 4 more ... | "access_monitor"; }[] | undefined; } | undefined; } & ({ ...; } | { ...; })
)
| (
{ code?: "subscription_required" | undefined; http_response_code?: 403 | undefined; detail?: string | { DATA_TYPE: "subscription_required#1.0.0"; add_ons?: string[] | undefined; subscription_level?: string | undefined; } | undefined; } & ({ ...; } | { ...; })
);
};
headers: { [name: string]: unknown };
}
409: {
content: {
"application/json": { code?: "exists"; http_response_code?: 409 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postSharingPolicy
postSharingPolicy: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
collection_id: string;
DATA_TYPE: "sharing_policy#1.0.0";
id?: string;
sharing_restrict_paths: {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users?: string[];
};
};
};
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: {
collection_id: string;
DATA_TYPE: "sharing_policy#1.0.0";
id?: string;
sharing_restrict_paths: {
DATA_TYPE: "path_restrictions#1.0.0";
none?: (...)
| (...);
read?: (...) | (...);
read_write?: (...) | (...);
};
users?: (...)[];
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json": {
collection_id: string;
DATA_TYPE: "sharing_policy#1.0.0";
id?: string;
sharing_restrict_paths: {
DATA_TYPE: "path_restrictions#1.0.0";
none?: string[];
read?: string[];
read_write?: string[];
};
users?: string[];
};
};
}
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: {
collection_id: string;
DATA_TYPE: "sharing_policy#1.0.0";
id?: string;
sharing_restrict_paths: {
DATA_TYPE: "path_restrictions#1.0.0";
none?: (...) | (...);
read?: (...) | (...);
read_write?: (...) | (...);
};
users?: (...)[];
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
201: {
content: {
"application/json": {
code?: "success";
data?: {
collection_id: string;
DATA_TYPE: "sharing_policy#1.0.0";
id?: string;
sharing_restrict_paths: {
DATA_TYPE: "path_restrictions#1.0.0";
none?: (...) | (...);
read?: (...) | (...);
read_write?: (...) | (...);
};
users?: (...)[];
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postStorageGateway: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": | {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
max_concurrency?: number;
max_parallelism?: number;
network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
preferred_concurrency?: number;
preferred_parallelism?: number;
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
};
};
};
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json":
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
max_concurrency?: number;
max_parallelism?: number;
network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
preferred_concurrency?: number;
preferred_parallelism?: number;
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
};
};
}
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
201: {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postUserCredential
postUserCredential: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| {
DATA_TYPE: "s3_user_credential_policies#1.0.0";
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.1.0";
s3_key_id?: null
| string;
s3_requester_pays?: boolean;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.2.0";
s3_key_id?: null
| string;
s3_multi_keys?:
| null
| {
path_prefixes: string[];
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}[];
s3_requester_pays?: boolean;
s3_secret_key?: null
| string;
}
| {
access_token?: null
| string;
DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| {
access_id?: string;
DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
secret_key?: string;
}
| { DATA_TYPE: "box_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "box_user_credential_policies#1.1.0";
email?: null | string;
max_upload?: number;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
root_info?: Record<string, unknown>;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
email?: string;
projects?: { name?: string; projectId?: string }[];
refresh_token?: null | string;
scopes?: string[];
sub?: string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
| { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
| { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
};
};
};
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json": {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| {
DATA_TYPE: "s3_user_credential_policies#1.0.0";
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.1.0";
s3_key_id?: null
| string;
s3_requester_pays?: boolean;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.2.0";
s3_key_id?: null
| string;
s3_multi_keys?:
| null
| {
path_prefixes: string[];
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}[];
s3_requester_pays?: boolean;
s3_secret_key?: null
| string;
}
| {
access_token?: null
| string;
DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| {
access_id?: string;
DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
secret_key?: string;
}
| { DATA_TYPE: "box_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "box_user_credential_policies#1.1.0";
email?: null | string;
max_upload?: number;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
root_info?: Record<string, unknown>;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
email?: string;
projects?: { name?: string; projectId?: string }[];
refresh_token?: null | string;
scopes?: string[];
sub?: string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
| { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
| { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
};
};
}
responses: {
"201": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
201: {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
postUserCredentials
postUserCredentials: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody?: {
content: {
"application/x-www-form-urlencoded": {
access_token?: string;
identity_id: string;
login_hint?: string;
redirect_uri: string;
storage_gateway: string;
};
};
};
responses: {
"303": { content?: undefined; headers: { [name: string]: unknown } };
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
OptionalrequestBody?: {
content: {
"application/x-www-form-urlencoded": {
access_token?: string;
identity_id: string;
login_hint?: string;
redirect_uri: string;
storage_gateway: string;
};
};
}
responses: {
"303": { content?: undefined; headers: { [name: string]: unknown } };
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
303: { content?: undefined; headers: { [name: string]: unknown } }
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putCollection
putCollection: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": | {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.0.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.1.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null
| string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.2.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.3.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.4.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.5.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.6.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.7.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.8.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.9.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.10.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.11.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.12.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null | number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.13.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.14.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
associated_flow_policy?: unknown;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.15.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { collection_id: string }
Optionalquery?: undefined
requestBody: {
content: {
"application/json":
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.0.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.1.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null
| string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.2.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.3.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.4.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.5.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null
| string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.6.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.7.0";
default_directory?: string;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
DATA_TYPE: "collection#1.8.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped"
| "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.9.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.10.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.11.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.12.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null | number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.13.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.14.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
}
| {
acl_expiration_mins?: null
| number;
activity_notification_policy?: {
status: string[];
transfer_use: string[];
};
allow_guest_collections?: boolean;
associated_flow_policy?: unknown;
authentication_timeout_mins?: number;
auto_delete_timeout?: null
| number;
collection_base_path: string;
collection_type: "mapped" | "guest";
connector_id?: string;
contact_email?: null | string;
contact_info?: null | string;
created_at?: null | string;
DATA_TYPE: "collection#1.15.0";
default_directory?: string;
delete_protected?: boolean;
deleted?: boolean;
department?: null | string;
description?: null | string;
disable_anonymous_writes?: boolean;
disable_verify?: boolean;
display_name: string;
domain?: {
certificate?: null | string;
certificate_chain?: null | string;
certificate_chain_path?: null | string;
certificate_path?: null | string;
DATA_TYPE: "domain#1.0.0";
domain_name: string;
private_key?: null | string;
private_key_path?: null | string;
wildcard: boolean;
};
domain_name?: string;
enable_https?: boolean;
force_encryption?: boolean;
force_verify?: boolean;
guest_auth_policy_id?: null
| string;
high_assurance?: boolean;
https_url?: string;
id?: string;
identity_id?: string;
info_link?: null | string;
keywords?: string[];
last_access?: null | string;
manager_url?: string;
mapped_collection_id?: string;
organization?: string;
policies?:
| { DATA_TYPE: "s3_collection_policies#1.0.0" }
| { DATA_TYPE: "azure_blob_collection_policies#1.0.0" }
| { DATA_TYPE: "blackpearl_collection_policies#1.0.0" }
| { DATA_TYPE: "box_collection_policies#1.0.0" }
| { DATA_TYPE: "ceph_collection_policies#1.0.0" }
| { DATA_TYPE: "dropbox_collection_policies#1.0.0" }
| {
DATA_TYPE: "google_cloud_storage_collection_policies#1.0.0";
project?: string;
}
| { DATA_TYPE: "google_drive_collection_policies#1.0.0" }
| { DATA_TYPE: "hpss_collection_policies#1.0.0" }
| { DATA_TYPE: "irods_collection_policies#1.0.0" }
| { DATA_TYPE: "onedrive_collection_policies#1.0.0" }
| { DATA_TYPE: "posix_collection_policies#1.0.0" }
| {
DATA_TYPE: "posix_collection_policies#1.1.0";
sharing_groups_allow?: null | string[];
sharing_groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_collection_policies#1.0.0";
sharing_groups_allow?: null
| string[];
sharing_groups_deny?: null | string[];
};
public: boolean;
require_mfa?: boolean;
restrict_transfers_to_high_assurance?: | null
| "inbound"
| "outbound"
| "all";
root_path?: string;
sharing_restrict_paths?: unknown;
sharing_users_allow?: null
| string[];
sharing_users_deny?: null | string[];
skip_auto_delete?: boolean;
storage_gateway_id?: string;
subscription_admin_verified?: boolean;
tlsftp_url?: string;
user_credential_id?: string;
user_message?: null | string;
user_message_link?: null | string;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putCollectionDomain
putCollectionDomain: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
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;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { collection_id: string }
Optionalquery?: undefined
requestBody: {
content: {
"application/json": {
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;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putCollectionOwnerString
putCollectionOwnerString: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
DATA_TYPE: "owner_string#1.0.0";
identity_id?: string;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { collection_id: string }
Optionalquery?: undefined
requestBody: {
content: {
"application/json": {
DATA_TYPE: "owner_string#1.0.0";
identity_id?: string;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putEndpoint
putEndpoint: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { include?: "endpoint"[] };
};
requestBody: {
content: {
"application/json": | {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.0.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.1.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.2.0";
department?: string;
description?: string;
display_name: string;
earliest_last_access?: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.0.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.1.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.2.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
earliest_last_access?: (...) | (...);
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { include?: "endpoint"[] };
}
Optionalcookie?: undefined
Optionalheader?: undefined
Optionalpath?: undefined
Optionalquery?: { include?: "endpoint"[] }
Optionalinclude?: "endpoint"[]
requestBody: {
content: {
"application/json":
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.0.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal"
| "minimal"
| "aggressive"
| "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.1.0";
department?: string;
description?: string;
display_name: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
}
| {
allow_udt?: boolean;
contact_email?: string;
contact_info?: string;
DATA_TYPE: "endpoint#1.2.0";
department?: string;
description?: string;
display_name: string;
earliest_last_access?: string;
gcs_manager_url?: string;
gridftp_control_channel_port?: null
| number;
id?: string;
info_link?: string;
keywords?: string[];
max_concurrency?: number;
max_parallelism?: number;
network_use: "normal" | "minimal" | "aggressive" | "custom";
organization?: string;
preferred_concurrency?: number;
preferred_parallelism?: number;
public: boolean;
subscription_id?: null | string;
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.0.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.1.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.2.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
earliest_last_access?: (...) | (...);
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: (
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.0.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.1.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
| {
allow_udt?: (...)
| (...)
| (...);
contact_email?: (...) | (...);
contact_info?: (...) | (...);
DATA_TYPE: "endpoint#1.2.0";
department?: (...) | (...);
description?: (...) | (...);
display_name: string;
earliest_last_access?: (...) | (...);
gcs_manager_url?: (...) | (...);
gridftp_control_channel_port?: (...) | (...) | (...);
id?: (...) | (...);
info_link?: (...) | (...);
keywords?: (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use: (...) | (...) | (...) | (...);
organization?: (...) | (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
public: boolean;
subscription_id?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putEndpointDomain
putEndpointDomain: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
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;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json": {
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;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putEndpointOwner
putEndpointOwner: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
DATA_TYPE: "endpoint_owner#1.0.0";
identity_id: string;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
putEndpointOwnerString
putEndpointOwnerString: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
DATA_TYPE: "owner_string#1.0.0";
identity_id?: string;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json": {
DATA_TYPE: "owner_string#1.0.0";
identity_id?: string;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putEndpointSubscriptionId
putEndpointSubscriptionId: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
DATA_TYPE: "endpoint_subscription#1.0.0";
subscription_id: null
| string;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
requestBody: {
content: {
"application/json": {
DATA_TYPE: "endpoint_subscription#1.0.0";
subscription_id: null | string;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putNode
putNode: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { node_id: string };
query?: { include?: "node"[] };
};
requestBody: {
content: {
"application/json": | {
DATA_TYPE: "node#1.0.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active"
| "inactive";
}
| {
data_interface?: null
| string;
DATA_TYPE: "node#1.1.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
}
| {
data_interface?: null
| string;
data_interface6?: null | string;
DATA_TYPE: "node#1.2.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { node_id: string };
query?: { include?: "node"[] };
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { node_id: string }
Optionalquery?: { include?: "node"[] }
Optionalinclude?: "node"[]
requestBody: {
content: {
"application/json":
| {
DATA_TYPE: "node#1.0.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active"
| "inactive";
}
| {
data_interface?: null
| string;
DATA_TYPE: "node#1.1.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
}
| {
data_interface?: null
| string;
data_interface6?: null | string;
DATA_TYPE: "node#1.2.0";
id?: string;
incoming_port_range?: number[];
ip_addresses: string[];
outgoing_port_range?: number[];
status: "active" | "inactive";
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: (
| {
DATA_TYPE: "node#1.0.0";
id?: (...)
| (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
DATA_TYPE: "node#1.1.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
| {
data_interface?: (...)
| (...)
| (...);
data_interface6?: (...) | (...) | (...);
DATA_TYPE: "node#1.2.0";
id?: (...) | (...);
incoming_port_range?: (...) | (...);
ip_addresses: (...)[];
outgoing_port_range?: (...) | (...);
status: (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putStorageGateway: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { storage_gateway_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": | {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
max_concurrency?: number;
max_parallelism?: number;
network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
preferred_concurrency?: number;
preferred_parallelism?: number;
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { storage_gateway_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { storage_gateway_id: string }
storage_gateway_id: string
Optionalquery?: undefined
requestBody: {
content: {
"application/json":
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
}
| {
admin_managed_credentials: boolean;
allowed_domains?: string[];
authentication_assurance_timeout?: null
| number;
authentication_timeout_mins?: null | number;
connector_id?: string;
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: boolean;
display_name?: string;
high_assurance?: null | boolean;
id?: string;
identity_mappings?:
| null
| (
| {
command?: (...)[];
DATA_TYPE: "external_identity_mapping#1.0.0";
}
| {
DATA_TYPE: "expression_identity_mapping#1.0.0";
mappings?: (...)[];
}
)[];
load_dsi_module?: null
| string;
max_concurrency?: number;
max_parallelism?: number;
network_use?: null | "normal" | "minimal" | "aggressive" | "custom";
policies?:
| {
DATA_TYPE: "s3_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.1.0";
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
DATA_TYPE: "s3_storage_policies#1.2.0";
s3_allow_multi_keys?: boolean;
s3_buckets?: string[];
s3_endpoint?: string;
s3_requester_pays?: boolean;
s3_user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.0.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
account: null
| string;
adls: null | boolean;
allow_any_account?: boolean;
auth_callback?: string;
auth_type: null | string;
client_id: null | string;
DATA_TYPE: "azure_blob_storage_policies#1.1.0";
secret: null | string;
tenant: null | string;
user_credential_required?: boolean;
}
| {
bp_access_id_file?: string;
DATA_TYPE: "blackpearl_storage_policies#1.0.0";
s3_endpoint?: string;
}
| {
boxAppSettings: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
DATA_TYPE: "box_storage_policies#1.0.0";
enterpriseID: string;
}
| {
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.1.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
boxAppSettings?: {
appAuth: {
passphrase: string;
privateKey: string;
publicKeyID: string;
};
clientID: string;
clientSecret: string;
};
client_id?: string;
DATA_TYPE: "box_storage_policies#1.2.0";
enterpriseID?: string;
secret?: string;
user_api_rate_limit?: number;
user_credential_required?: boolean;
}
| {
ceph_admin_key_id?: string;
ceph_admin_secret_key?: string;
DATA_TYPE: "ceph_storage_policies#1.0.0";
s3_buckets?: string[];
s3_endpoint?: string;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "dropbox_storage_policies#1.0.0";
secret: null | string;
user_api_rate_limit?: number;
}
| {
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.0.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
buckets?: null
| string[];
client_id: null | string;
DATA_TYPE: "google_cloud_storage_policies#1.1.0";
projects?: null | string[];
secret: null | string;
service_account_key?: null | Record<string, unknown>;
user_credential_required?: boolean;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.0.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "google_drive_storage_policies#1.1.0";
secret: null | string;
user_api_rate_quota?: number;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.0.0";
uda_checksum: boolean;
}
| {
authentication_mech: "krb5"
| "unix";
authenticator: string;
DATA_TYPE: "hpss_storage_policies#1.1.0";
login_name?: string;
uda_checksum: boolean;
}
| {
DATA_TYPE: "irods_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
irods_authentication_file?: string;
irods_environment_file: string;
}
| {
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.0.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
allow_any_account?: boolean;
auth_callback?: string;
client_id: null
| string;
DATA_TYPE: "onedrive_storage_policies#1.1.0";
secret: null | string;
tenant?: null | string;
user_api_rate_limit?: number;
}
| {
DATA_TYPE: "posix_storage_policies#1.0.0";
groups_allow?: null
| string[];
groups_deny?: null | string[];
}
| {
DATA_TYPE: "posix_staging_storage_policies#1.0.0";
environment?: { name: string; value: string }[];
groups_allow?: null | string[];
groups_deny?: null | string[];
stage_app: string;
};
preferred_concurrency?: number;
preferred_parallelism?: number;
process_user?: null
| string;
require_high_assurance?: null | boolean;
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: null | string[];
users_deny?: null | string[];
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: (
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.0.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.1.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.2.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
| {
admin_managed_credentials: boolean;
allowed_domains?: (...)
| (...);
authentication_assurance_timeout?: (...) | (...) | (...);
authentication_timeout_mins?: (...) | (...) | (...);
connector_id?: (...) | (...);
DATA_TYPE: "storage_gateway#1.3.0";
deleted?: (...) | (...) | (...);
display_name?: (...) | (...);
high_assurance?: (...) | (...) | (...) | (...);
id?: (...) | (...);
identity_mappings?: (...) | (...) | (...);
load_dsi_module?: (...) | (...) | (...);
max_concurrency?: (...) | (...);
max_parallelism?: (...) | (...);
network_use?: (...) | (...) | (...) | (...) | (...) | (...);
policies?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
preferred_concurrency?: (...) | (...);
preferred_parallelism?: (...) | (...);
process_user?: (...) | (...) | (...);
require_high_assurance?: (...) | (...) | (...) | (...);
require_mfa: boolean;
restrict_paths?: unknown;
users_allow?: (...) | (...) | (...);
users_deny?: (...) | (...) | (...);
}
)[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?:
| string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putSubscriptionAdminVerified
putSubscriptionAdminVerified: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
DATA_TYPE: "subscription_admin_verified#1.0.0";
subscription_admin_verified: boolean;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { collection_id: string }
Optionalquery?: undefined
requestBody: {
content: {
"application/json": {
DATA_TYPE: "subscription_admin_verified#1.0.0";
subscription_admin_verified: boolean;
};
};
}
responses: {
"200": {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json":
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
401: {
content: {
"application/json": {
code?: "not_authorized";
detail?:
| string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
putUserCredential
putUserCredential: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { user_credential_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| {
DATA_TYPE: "s3_user_credential_policies#1.0.0";
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.1.0";
s3_key_id?: null
| string;
s3_requester_pays?: boolean;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.2.0";
s3_key_id?: null
| string;
s3_multi_keys?:
| null
| {
path_prefixes: string[];
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}[];
s3_requester_pays?: boolean;
s3_secret_key?: null
| string;
}
| {
access_token?: null
| string;
DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| {
access_id?: string;
DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
secret_key?: string;
}
| { DATA_TYPE: "box_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "box_user_credential_policies#1.1.0";
email?: null | string;
max_upload?: number;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
root_info?: Record<string, unknown>;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
email?: string;
projects?: { name?: string; projectId?: string }[];
refresh_token?: null | string;
scopes?: string[];
sub?: string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
| { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
| { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
};
};
};
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null
| string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Type declaration
parameters: {
cookie?: undefined;
header?: undefined;
path: { user_credential_id: string };
query?: undefined;
}
Optionalcookie?: undefined
Optionalheader?: undefined
path: { user_credential_id: string }
user_credential_id: string
Optionalquery?: undefined
requestBody: {
content: {
"application/json": {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| {
DATA_TYPE: "s3_user_credential_policies#1.0.0";
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.1.0";
s3_key_id?: null
| string;
s3_requester_pays?: boolean;
s3_secret_key?: null | string;
}
| {
DATA_TYPE: "s3_user_credential_policies#1.2.0";
s3_key_id?: null
| string;
s3_multi_keys?:
| null
| {
path_prefixes: string[];
s3_key_id?: null
| string;
s3_secret_key?: null | string;
}[];
s3_requester_pays?: boolean;
s3_secret_key?: null
| string;
}
| {
access_token?: null
| string;
DATA_TYPE: "azure_blob_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| {
access_id?: string;
DATA_TYPE: "blackpearl_user_credential_policies#1.0.0";
secret_key?: string;
}
| { DATA_TYPE: "box_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "box_user_credential_policies#1.1.0";
email?: null | string;
max_upload?: number;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "ceph_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "dropbox_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
root_info?: Record<string, unknown>;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_cloud_storage_user_credential_policies#1.0.0";
email?: string;
projects?: { name?: string; projectId?: string }[];
refresh_token?: null | string;
scopes?: string[];
sub?: string;
token_expiry?: string;
}
| {
access_token?: null
| string;
DATA_TYPE: "google_drive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
token_expiry?: string;
}
| { DATA_TYPE: "hpss_user_credential_policies#1.0.0" }
| { DATA_TYPE: "irods_user_credential_policies#1.0.0" }
| {
access_token?: null | string;
DATA_TYPE: "onedrive_user_credential_policies#1.0.0";
email?: null | string;
refresh_token?: null | string;
scopes?: string[];
sub?: null | string;
tid?: string;
token_expiry?: string;
}
| { DATA_TYPE: "posix_user_credential_policies#1.0.0" }
| { DATA_TYPE: "posix_staging_user_credential_policies#1.0.0" };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
};
};
}
responses: {
"200": {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: string
| { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
}
200: {
content: {
"application/json": {
code?: "success";
data?: {
connector_id?: string;
DATA_TYPE: "user_credential#1.0.0";
deleted?: boolean;
display_name?: null | string;
home_directory?: string;
id?: string;
identity_id?: string;
invalid?: boolean;
policies?:
| { DATA_TYPE: ...; s3_key_id?: ...; s3_secret_key?: ... }
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
DATA_TYPE: ...;
s3_key_id?: ...;
s3_multi_keys?: ...;
s3_requester_pays?: ...;
s3_secret_key?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { access_id?: ...; DATA_TYPE: ...; secret_key?: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
max_upload?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
root_info?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
projects?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... }
| {
access_token?: ...;
DATA_TYPE: ...;
email?: ...;
refresh_token?: ...;
scopes?: ...;
sub?: ...;
tid?: ...;
token_expiry?: ...;
}
| { DATA_TYPE: ... }
| { DATA_TYPE: ... };
provisioned?: boolean;
storage_gateway_id?: string;
username?: string;
}[];
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
400: {
content: {
"application/json": { code?: "bad_request"; http_response_code?: 400 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
403: {
content: {
"application/json": {
code?: "permission_denied";
detail?: string | { DATA_TYPE: "not_resource_owner#1.0.0"; id?: string };
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
404: {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
415: {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
422: {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?:
| string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
}
setCollectionOwner
setCollectionOwner: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { collection_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
DATA_TYPE: "collection_owner#1.0.0";
identity_id: string;
};
};
};
responses: {
"200": {
content: {
"application/json": | {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
code?: "bad_request";
http_response_code?: 400;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
code?: "not_authorized";
detail?: | string
| {
DATA_TYPE: "missing_required_scopes#1.0.0";
required_scopes?: string[];
};
http_response_code?: 401;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code?: "permission_denied";
detail?: | string
| {
DATA_TYPE: "missing_required_role#1.0.0";
roles?: { collection?: ...; role: ... }[];
};
http_response_code?: 403;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"404": {
content: {
"application/json": { code?: "not_found"; http_response_code?: 404 } & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"415": {
content: {
"application/json": {
code?: "unsupported_media_type";
http_response_code?: 415;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
code?: "unprocessable_entity";
detail?: | string
| {
DATA_TYPE: "invalid_input#1.0.0";
errors?: { message: ...; property?: ... }[];
};
http_response_code?: 422;
} & (
| {
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.0.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
| {
authorization_parameters?: null
| { [key: string]: unknown };
code: string;
data?: Record<string, unknown>[];
DATA_TYPE: "result#1.1.0";
detail?: unknown;
has_next_page: boolean;
http_response_code: number;
marker?: null | string;
message?: string;
}
);
};
headers: { [name: string]: unknown };
};
};
}
Description
Id of the collection