True Cloud API
เอกสารอ้างอิง True Cloud จากโค้ด iOS — อ่าน endpoint / schema ได้ที่นี่ ปุ่ม Copy คือคัดลอก cURL ไปยิงเอง ไม่มีการเรียก API จากหน้าเว็บ
Using True Cloud APIs
All customer APIs (except shared-object login) require an access token. Endpoints are labeled by caller layer:
- Native REST — called directly via
NetworkingProvider<TrueCloudAPI>. Paths under /v1/....
- AWS S3 SDK — binary upload/download via
AWSS3TransferUtility. Not True Cloud REST paths.
No True Cloud REST endpoint is invoked through an SDK. The AWS SDK talks to S3 after native STS.
Domain / Servers
Resolved by DomainNameManager: Firestore → Documents cache → bundled ConfigDomain.json.
tc-customer
PathDomain
trueCloudCustomer
Base
https://drive-customer-api.trueid.net/drive/
tc-share
PathDomain
trueCloudShare
Base
https://cloudshare.trueid.net/public-api/
truecloud.trueid.net is deeplink/share UI host, not API base.
Native vs SDK
NativeAll TrueCloudAPI / PhotoEditorAPI cases, including STS.
SDKAWSS3TransferUtility upload/download using STS credentials.
Storage
GETNative REST
Get Storage Info
GET /v1/users/{ssoId}/storage
Get quota, usage, root folder, and migration status.
Server
tc-customer
Operation ID
getStorageInfo
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · StorageInfoResponse
StorageInfoResponse StorageInfoResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageInfoData? | optional | Expand StorageInfoDataStorageInfoData StorageInfoResponse.swift | Name | Type | | |
|---|
quota_size | UInt64 | required | | data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| root_folder | StorageObjectData? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| data_migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
|
StorageInfoData StorageInfoResponse.swift
| Name | Type | | |
|---|
quota_size | UInt64 | required | |
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
root_folder | StorageObjectData? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
data_migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
GET/v1/users/{ssoId}/storage
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/storage' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Storage Objects
GET /v1/users/{ssoId}/folders/{parentId}
List objects inside a folder.
Server
tc-customer
Operation ID
getStorageObjects
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
GetStorageObjectsRequest GetStorageObjectsRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectListData | required | Expand StorageObjectListDataStorageObjectListData StorageObjectResponse.swift | Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
| data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| folders | [FolderObjectModel] | required | | items | [FolderObjectModel] | required | | files | [FileObjectModel] | required | | items | [FileObjectModel] | required | |
|
StorageObjectListData StorageObjectResponse.swift
| Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
|
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
folders | [FolderObjectModel] | required | |
items | [FolderObjectModel] | required | |
files | [FileObjectModel] | required | |
items | [FileObjectModel] | required | |
GET/v1/users/{ssoId}/folders/{parentId}
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/folders/{parentId}' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Objects By Category
GET /v1/users/{ssoId}/files
List files filtered by category.
Server
tc-customer
Operation ID
getObjectsByCategory
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
GetObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
category | String | required | |
order | SortingOrder | required | |
Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectListData | required | Expand StorageObjectListDataStorageObjectListData StorageObjectResponse.swift | Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
| data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| folders | [FolderObjectModel] | required | | items | [FolderObjectModel] | required | | files | [FileObjectModel] | required | | items | [FileObjectModel] | required | |
|
StorageObjectListData StorageObjectResponse.swift
| Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
|
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
folders | [FolderObjectModel] | required | |
items | [FolderObjectModel] | required | |
files | [FileObjectModel] | required | |
items | [FileObjectModel] | required | |
GET/v1/users/{ssoId}/files
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Recent Upload Objects
GET /v1/users/{ssoId}/files
List recent uploads.
Server
tc-customer
Operation ID
getRecentUploadObjects
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
GetRecentUploadRequest GetRecentUploadRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectListData | required | Expand StorageObjectListDataStorageObjectListData StorageObjectResponse.swift | Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
| data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| folders | [FolderObjectModel] | required | | items | [FolderObjectModel] | required | | files | [FileObjectModel] | required | | items | [FileObjectModel] | required | |
|
StorageObjectListData StorageObjectResponse.swift
| Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
|
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
folders | [FolderObjectModel] | required | |
items | [FolderObjectModel] | required | |
files | [FileObjectModel] | required | |
items | [FileObjectModel] | required | |
GET/v1/users/{ssoId}/files
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Audio Object
GET /v1/users/{ssoId}/objects/{objectId}
Get a media object, optionally with pre-signed URL.
Server
tc-customer
Operation ID
getAudioObject
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
GetObjectWithPreSignURLRequest GetObjectWithPreSignURLRequest.swift
| Name | Type | | |
|---|
presignUrl | Bool | required | |
Responses
200 Success · MediaObjectResponse
MediaObjectResponse MediaObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platformModule | Int? | optional | |
reportDashboard | Int? | optional | |
data | MediaObjectData | required | Expand MediaObjectDataMediaObjectData MediaObjectResponse.swift | Name | Type | | |
|---|
id | String? | optional | | file_url | String? | optional | |
|
MediaObjectData MediaObjectResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
file_url | String? | optional | |
GET/v1/users/{ssoId}/objects/{objectId}
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/{objectId}' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
File
POSTNative REST
Initial Upload
POST /v1/users/{ssoId}/file
Create upload metadata. Binary bytes are uploaded via AWS SDK after STS.
Server
tc-customer
Operation ID
initialUpload
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
InitialUploadRequest InitialUploadRequest.swift
| Name | Type | | |
|---|
parent_object_id | String | required | |
name | String | required | |
mime_type | String | required | |
size | UInt64 | required | |
Responses
200 Success · InitialUploadResponse
InitialUploadResponse InitialUploadResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | InitialUploadData | required | Expand InitialUploadDataInitialUploadData InitialUploadResponse.swift | Name | Type | | |
|---|
id | String | required | | object_type | StorageObjectType | required | | parent_object_id | String? | optional | | name | String | required | | mime_type | String? | optional | | category | FileCategory? | optional | | size | UInt64 | required | | is_uploaded | Bool | required | |
|
InitialUploadData InitialUploadResponse.swift
| Name | Type | | |
|---|
id | String | required | |
object_type | StorageObjectType | required | |
parent_object_id | String? | optional | |
name | String | required | |
mime_type | String? | optional | |
category | FileCategory? | optional | |
size | UInt64 | required | |
is_uploaded | Bool | required | |
POST/v1/users/{ssoId}/file
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/file' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
POSTNative REST
Retry Upload
POST /v1/users/{ssoId}/file/{objectId}
Retry an upload session. Empty JSON body.
Server
tc-customer
Operation ID
retryUpload
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
(empty object) | object |
Responses
200 Success · InitialUploadResponse
InitialUploadResponse InitialUploadResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | InitialUploadData | required | Expand InitialUploadDataInitialUploadData InitialUploadResponse.swift | Name | Type | | |
|---|
id | String | required | | object_type | StorageObjectType | required | | parent_object_id | String? | optional | | name | String | required | | mime_type | String? | optional | | category | FileCategory? | optional | | size | UInt64 | required | | is_uploaded | Bool | required | |
|
InitialUploadData InitialUploadResponse.swift
| Name | Type | | |
|---|
id | String | required | |
object_type | StorageObjectType | required | |
parent_object_id | String? | optional | |
name | String | required | |
mime_type | String? | optional | |
category | FileCategory? | optional | |
size | UInt64 | required | |
is_uploaded | Bool | required | |
POST/v1/users/{ssoId}/file/{objectId}
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/file/{objectId}' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
PATCHNative REST
Complete Upload
PATCH /v1/users/{ssoId}/files/{objectId}
Mark upload complete after AWS TransferUtility finishes.
Server
tc-customer
Operation ID
completeUpload
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
CompleteUploadRequest CompleteUploadRequest.swift
| Name | Type | | |
|---|
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectData | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
StorageObjectData StorageObjectResponse.swift
| Name | Type | | |
|---|
id | String | required | |
parent_object_id | String? | optional | |
object_type | StorageObjectType | required | |
name | String | required | |
category | FileCategory? | optional | |
size | UInt64? | optional | |
mime_type | String? | optional | |
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
delete_in | Date? | optional | |
shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
PATCH/v1/users/{ssoId}/files/{objectId}
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/{objectId}' \
2
--request PATCH \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
PATCHNative REST
Complete Re Upload
PATCH /v1/users/{ssoId}/files/{objectId}
Complete cover-image re-upload (PhotoEditorAPI).
Server
tc-customer
Operation ID
completeReUpload
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
ChangeCoverObjectRequest ChangeCoverObjectRequest.swift
| Name | Type | | |
|---|
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectData | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
StorageObjectData StorageObjectResponse.swift
| Name | Type | | |
|---|
id | String | required | |
parent_object_id | String? | optional | |
object_type | StorageObjectType | required | |
name | String | required | |
category | FileCategory? | optional | |
size | UInt64? | optional | |
mime_type | String? | optional | |
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
delete_in | Date? | optional | |
shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
PATCH/v1/users/{ssoId}/files/{objectId}
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/{objectId}' \
2
--request PATCH \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
POSTNative REST
Create Folder
POST /v1/users/{ssoId}/folder
Create a folder.
Server
tc-customer
Operation ID
createFolder
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
CreateFolderRequest CreateFolderRequest.swift
| Name | Type | | |
|---|
name | String | required | |
parent_object_id | String | required | |
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectData | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
StorageObjectData StorageObjectResponse.swift
| Name | Type | | |
|---|
id | String | required | |
parent_object_id | String? | optional | |
object_type | StorageObjectType | required | |
name | String | required | |
category | FileCategory? | optional | |
size | UInt64? | optional | |
mime_type | String? | optional | |
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
delete_in | Date? | optional | |
shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
POST/v1/users/{ssoId}/folder
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/folder' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
PATCHNative REST
Rename File
PATCH /v1/users/{ssoId}/files/{objectId}/rename
Rename a file or folder.
Server
tc-customer
Operation ID
renameFile
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectData | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
StorageObjectData StorageObjectResponse.swift
| Name | Type | | |
|---|
id | String | required | |
parent_object_id | String? | optional | |
object_type | StorageObjectType | required | |
name | String | required | |
category | FileCategory? | optional | |
size | UInt64? | optional | |
mime_type | String? | optional | |
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
delete_in | Date? | optional | |
shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
PATCH/v1/users/{ssoId}/files/{objectId}/rename
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/{objectId}/rename' \
2
--request PATCH \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
DELETENative REST
Delete File
DELETE /v1/users/{ssoId}/files/{objectId}
Delete a file or object.
Server
tc-customer
Operation ID
deleteFile
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectData | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
StorageObjectData StorageObjectResponse.swift
| Name | Type | | |
|---|
id | String | required | |
parent_object_id | String? | optional | |
object_type | StorageObjectType | required | |
name | String | required | |
category | FileCategory? | optional | |
size | UInt64? | optional | |
mime_type | String? | optional | |
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
delete_in | Date? | optional | |
shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
DELETE/v1/users/{ssoId}/files/{objectId}
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/{objectId}' \
2
--request DELETE \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
POSTNative REST
Move Objects
POST /v1/users/{ssoId}/objects/move
Move objects to another parent folder.
Server
tc-customer
Operation ID
moveObjects
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
parent_object_id | string |
object_ids | string[] |
Responses
200 Success · MoveObjectResponse
MoveObjectResponse MoveObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platform_module | Int? | optional | |
report_dashboard | Int? | optional | |
data | MoveObjectData | required | Expand MoveObjectDataMoveObjectData MoveObjectResponse.swift | Name | Type | | |
|---|
count | Int? | optional | |
|
MoveObjectData MoveObjectResponse.swift
| Name | Type | | |
|---|
count | Int? | optional | |
POST/v1/users/{ssoId}/objects/move
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/move' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
POSTNative REST
Copy Objects
POST /v1/users/{ssoId}/objects/copy
Copy objects to another parent folder.
Server
tc-customer
Operation ID
copyObjects
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
parent_object_id | string |
object_ids | string[] |
Responses
200 Success · CopyObjectResponse
CopyObjectResponse CopyObjectResponse.swift
| Name | Type | | |
|---|
code | Int | required | |
message | String | required | |
platform_module | Int | required | |
report_dashboard | Int | required | |
data | [CopyObjectData] | required | Expand CopyObjectDataCopyObjectData CopyObjectResponse.swift | Name | Type | | |
|---|
id | String? | optional | | parent_object_id | String | required | | name | String? | optional | | shared_object_id | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | |
|
CopyObjectData CopyObjectResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
parent_object_id | String | required | |
name | String? | optional | |
shared_object_id | String? | optional | |
updated_at | String? | optional | |
created_at | String? | optional | |
POST/v1/users/{ssoId}/objects/copy
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/copy' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
Trash
POSTNative REST
Remove Objects To Trash
POST /v1/users/{ssoId}/objects/trash/move
Move objects into trash.
Server
tc-customer
Operation ID
removeObjectsToTrash
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
object_ids | string[] |
Responses
200 Success · RemoveObjectsToTrashResponse
RemoveObjectsToTrashResponse MoveObjectsToTrashResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | RemoveObjectsToTrashData | required | Expand RemoveObjectsToTrashDataRemoveObjectsToTrashData MoveObjectsToTrashResponse.swift | Name | Type | | |
|---|
updated | String | required | |
|
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
| Name | Type | | |
|---|
updated | String | required | |
POST/v1/users/{ssoId}/objects/trash/move
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/trash/move' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
POSTNative REST
Move Objects To Trash
POST /v1/users/{ssoId}/objects/trash
Alternate trash move using a raw object-id array. Unused in current repositories.
Server
tc-customer
Operation ID
moveObjectsToTrash
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · RemoveObjectsToTrashResponse
RemoveObjectsToTrashResponse MoveObjectsToTrashResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | RemoveObjectsToTrashData | required | Expand RemoveObjectsToTrashDataRemoveObjectsToTrashData MoveObjectsToTrashResponse.swift | Name | Type | | |
|---|
updated | String | required | |
|
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
| Name | Type | | |
|---|
updated | String | required | |
POST/v1/users/{ssoId}/objects/trash
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/trash' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
GETNative REST
Get Trash Objects
GET /v1/users/{ssoId}/objects/trash
List trash objects.
Server
tc-customer
Operation ID
getTrashObjects
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
| Name | Type |
|---|
sort | string |
skip | integer |
take | integer |
Responses
200 Success · TrashObjectListResponse
TrashObjectListResponse TrashObjectListResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | TrashObjectListData | required | Expand TrashObjectListDataTrashObjectListData TrashObjectListResponse.swift | Name | Type | | |
|---|
uploaded | [StorageObjectData] | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
|
|
TrashObjectListData TrashObjectListResponse.swift
| Name | Type | | |
|---|
uploaded | [StorageObjectData] | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
GET/v1/users/{ssoId}/objects/trash
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/trash' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
POSTNative REST
Restore Objects From Trash
POST /v1/users/{ssoId}/objects/trash/restore
Restore objects from trash.
Server
tc-customer
Operation ID
restoreObjectsFromTrash
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
object_ids | string[] |
Responses
200 Success · RestoreObjectsResponse
RestoreObjectsResponse RestoreObjectsResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | RestoreObjectsData | required | Expand RestoreObjectsDataRestoreObjectsData RestoreObjectsResponse.swift | Name | Type | | |
|---|
updated | String | required | |
|
RestoreObjectsData RestoreObjectsResponse.swift
| Name | Type | | |
|---|
updated | String | required | |
POST/v1/users/{ssoId}/objects/trash/restore
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/trash/restore' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
POSTNative REST
Delete Objects From Trash
POST /v1/users/{ssoId}/objects/trash/delete
Permanently delete objects from trash.
Server
tc-customer
Operation ID
deleteObjectsFromTrash
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
object_ids | string[] |
Responses
200 Success · DeleteObjectsResponse
DeleteObjectsResponse DeleteObjectsResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | DeleteObjectsData | required | Expand DeleteObjectsDataDeleteObjectsData DeleteObjectsResponse.swift | Name | Type | | |
|---|
deleted | String | required | |
|
DeleteObjectsData DeleteObjectsResponse.swift
| Name | Type | | |
|---|
deleted | String | required | |
POST/v1/users/{ssoId}/objects/trash/delete
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/trash/delete' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
POSTNative REST
Empty Trash
POST /v1/users/{ssoId}/objects/trash/empty
Empty trash.
Server
tc-customer
Operation ID
emptyTrash
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
object_ids | string[] |
Responses
200 Success · DeleteObjectsResponse
DeleteObjectsResponse DeleteObjectsResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | DeleteObjectsData | required | Expand DeleteObjectsDataDeleteObjectsData DeleteObjectsResponse.swift | Name | Type | | |
|---|
deleted | String | required | |
|
DeleteObjectsData DeleteObjectsResponse.swift
| Name | Type | | |
|---|
deleted | String | required | |
POST/v1/users/{ssoId}/objects/trash/empty
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/trash/empty' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
Share
POSTNative REST
Share File
POST /v1/users/{ssoId}/files/{objectId}/share
Create a share link for a file.
Server
tc-customer
Operation ID
shareFile
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · ShareFileResponse
ShareFileResponse ShareFileResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platform_module | Int? | optional | |
report_dashboard | Int? | optional | |
data | ShareFileData | required | Expand ShareFileDataShareFileData ShareFileResponse.swift | Name | Type | | |
|---|
id | String? | optional | | is_private | Bool? | optional | | password | String? | optional | | expire_at | Date? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | shared_url | String? | optional | |
|
ShareFileData ShareFileResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
is_private | Bool? | optional | |
password | String? | optional | |
expire_at | Date? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
shared_url | String? | optional | |
POST/v1/users/{ssoId}/files/{objectId}/share
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/{objectId}/share' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Share File Config
GET /v1/users/{ssoId}/files/{objectId}/share
Get share configuration.
Server
tc-customer
Operation ID
getShareFileConfig
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · ShareFileResponse
ShareFileResponse ShareFileResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platform_module | Int? | optional | |
report_dashboard | Int? | optional | |
data | ShareFileData | required | Expand ShareFileDataShareFileData ShareFileResponse.swift | Name | Type | | |
|---|
id | String? | optional | | is_private | Bool? | optional | | password | String? | optional | | expire_at | Date? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | shared_url | String? | optional | |
|
ShareFileData ShareFileResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
is_private | Bool? | optional | |
password | String? | optional | |
expire_at | Date? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
shared_url | String? | optional | |
GET/v1/users/{ssoId}/files/{objectId}/share
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/{objectId}/share' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
PATCHNative REST
Update Share File Config
PATCH /v1/users/{ssoId}/files/{objectId}/share
Update share password, expiry, or privacy.
Server
tc-customer
Operation ID
updateShareFileConfig
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
UpdateSharedFileConfig UpdateSharedFileConfig.swift
| Name | Type | | |
|---|
is_private | Bool? | optional | |
password | String? | optional | |
is_new_password | Bool? | optional | |
expire_at | String? | optional | |
Responses
200 Success · ShareFileResponse
ShareFileResponse ShareFileResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platform_module | Int? | optional | |
report_dashboard | Int? | optional | |
data | ShareFileData | required | Expand ShareFileDataShareFileData ShareFileResponse.swift | Name | Type | | |
|---|
id | String? | optional | | is_private | Bool? | optional | | password | String? | optional | | expire_at | Date? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | shared_url | String? | optional | |
|
ShareFileData ShareFileResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
is_private | Bool? | optional | |
password | String? | optional | |
expire_at | Date? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
shared_url | String? | optional | |
PATCH/v1/users/{ssoId}/files/{objectId}/share
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/{objectId}/share' \
2
--request PATCH \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
GETNative REST
Get Shared Object
GET /v1/shared-objects/{sharedObjectId}
Fetch a shared object from the public share API.
Server
tc-share
Operation ID
getSharedObject
Called via
NetworkingProvider (native)
Authentication
SharedObjectToken Required
Headers
| Name | Type |
|---|
Authorization | Bearer {sharedObjectAccessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · SharedObjectResponse
SharedObjectResponse SharedObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | SharedObjectData | required | Expand SharedObjectDataSharedObjectData SharedObjectResponse.swift | Name | Type | | |
|---|
id | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | | object | SharedObject? | optional | Expand SharedObjectSharedObject SharedObjectResponse.swift | Name | Type | | |
|---|
file_url | String? | optional | | id | String? | optional | | object_type | String? | optional | | category | FileCategory? | optional | | cover_image_key | String? | optional | | mime_type | String? | optional | | name | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | |
|
|
SharedObjectData SharedObjectResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
updated_at | String? | optional | |
created_at | String? | optional | |
object | SharedObject? | optional | Expand SharedObjectSharedObject SharedObjectResponse.swift | Name | Type | | |
|---|
file_url | String? | optional | | id | String? | optional | | object_type | String? | optional | | category | FileCategory? | optional | | cover_image_key | String? | optional | | mime_type | String? | optional | | name | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | |
|
GET/v1/shared-objects/{sharedObjectId}
Shell Curl
1
curl 'https://cloudshare.trueid.net/public-api/v1/shared-objects/{sharedObjectId}' \
2
--request GET \
3
--header 'Authorization: Bearer {sharedObjectAccessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
POSTNative REST
Login Shared Object
POST /v1/auth/shared-objects/login
Login to a password-protected shared object. No Bearer header.
Server
tc-share
Operation ID
loginSharedObject
Called via
NetworkingProvider (native)
Headers
No Authorization header.
Query Parameters
None (path params only).
Body
| Name | Type |
|---|
encrypted_shared_object_id | string |
password | string |
Responses
200 Success · SharedObjectLoginResponse
SharedObjectLoginResponse SharedObjectLoginResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | SharedObjectLoginData | required | Expand SharedObjectLoginDataSharedObjectLoginData SharedObjectLoginResponse.swift | Name | Type | | |
|---|
shared_object_access_token | String? | optional | |
|
SharedObjectLoginData SharedObjectLoginResponse.swift
| Name | Type | | |
|---|
shared_object_access_token | String? | optional | |
POST/v1/auth/shared-objects/login
Shell Curl
1
curl 'https://cloudshare.trueid.net/public-api/v1/auth/shared-objects/login' \
2
--request POST \
3
--header 'Content-Type: application/json' \
4
--data '{...}'
Search
GETNative REST
Get Search Storage Objects
GET /v1/users/{ssoId}/objects/search
Search objects in storage.
Server
tc-customer
Operation ID
getSearchStorageObjects
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
GetSearchStorageObjectsRequest GetSearchStorageObjectsRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
name | String | required | |
Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectListData | required | Expand StorageObjectListDataStorageObjectListData StorageObjectResponse.swift | Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
| data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| folders | [FolderObjectModel] | required | | items | [FolderObjectModel] | required | | files | [FileObjectModel] | required | | items | [FileObjectModel] | required | |
|
StorageObjectListData StorageObjectResponse.swift
| Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
|
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
folders | [FolderObjectModel] | required | |
items | [FolderObjectModel] | required | |
files | [FileObjectModel] | required | |
items | [FileObjectModel] | required | |
GET/v1/users/{ssoId}/objects/search
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/objects/search' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Search Objects By Category
GET /v1/users/{ssoId}/files/search
Search files by category.
Server
tc-customer
Operation ID
getSearchObjectsByCategory
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
GetSearchObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
category | String | required | |
order | SortingOrder | required | |
name | String | required | |
Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectListData | required | Expand StorageObjectListDataStorageObjectListData StorageObjectResponse.swift | Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
| data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| folders | [FolderObjectModel] | required | | items | [FolderObjectModel] | required | | files | [FileObjectModel] | required | | items | [FileObjectModel] | required | |
|
StorageObjectListData StorageObjectResponse.swift
| Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
|
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
folders | [FolderObjectModel] | required | |
items | [FolderObjectModel] | required | |
files | [FileObjectModel] | required | |
items | [FileObjectModel] | required | |
GET/v1/users/{ssoId}/files/search
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/search' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Search Recent Upload Objects
GET /v1/users/{ssoId}/files/search
Search recent uploads.
Server
tc-customer
Operation ID
getSearchRecentUploadObjects
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
GetSearchRecentUploadRequest GetRecentUploadRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
name | String | required | |
Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectListData | required | Expand StorageObjectListDataStorageObjectListData StorageObjectResponse.swift | Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
| data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| folders | [FolderObjectModel] | required | | items | [FolderObjectModel] | required | | files | [FileObjectModel] | required | | items | [FileObjectModel] | required | |
|
StorageObjectListData StorageObjectResponse.swift
| Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
|
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
folders | [FolderObjectModel] | required | |
items | [FolderObjectModel] | required | |
files | [FileObjectModel] | required | |
items | [FileObjectModel] | required | |
GET/v1/users/{ssoId}/files/search
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/files/search' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
GETNative REST
Get Contact Last Update
GET /v1/users/{ssoId}/contact
Get contact backup last-update object.
Server
tc-customer
Operation ID
getContactLastUpdate
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectData | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
StorageObjectData StorageObjectResponse.swift
| Name | Type | | |
|---|
id | String | required | |
parent_object_id | String? | optional | |
object_type | StorageObjectType | required | |
name | String | required | |
category | FileCategory? | optional | |
size | UInt64? | optional | |
mime_type | String? | optional | |
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
delete_in | Date? | optional | |
shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
GET/v1/users/{ssoId}/contact
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/contact' \
2
--request GET \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
STS
POSTNative REST
Get Secure Token Service
POST /v1/users/{ssoId}/sts
Return AWS STS credentials used to configure AWSS3TransferUtility. Called by native code, not by the SDK.
Server
tc-customer
Operation ID
getSecureTokenService
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · SecureTokenServiceResponse
SecureTokenServiceResponse SecureTokenServiceResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | SecureTokenServiceData | required | Expand SecureTokenServiceDataSecureTokenServiceData SecureTokenServiceResponse.swift | Name | Type | | |
|---|
access_token | String | required | | secret_key | String | required | | session_key | String | required | | endpoint | String | required | | expires_at | Date? | optional | |
|
SecureTokenServiceData SecureTokenServiceResponse.swift
| Name | Type | | |
|---|
access_token | String | required | |
secret_key | String | required | |
session_key | String | required | |
endpoint | String | required | |
expires_at | Date? | optional | |
POST/v1/users/{ssoId}/sts
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/sts' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
Migration
POSTNative REST
Migrate Data
POST /v1/users/{ssoId}/migration
Trigger storage migration.
Server
tc-customer
Operation ID
migrateData
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Responses
200 Success · StorageMigrationStatusResponse
StorageMigrationStatusResponse StorageMigrationStatusResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageMigrationStatusData | required | Expand StorageMigrationStatusDataStorageMigrationStatusData StorageMigrationStatusResponse.swift | Name | Type | | |
|---|
migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
|
StorageMigrationStatusData StorageMigrationStatusResponse.swift
| Name | Type | | |
|---|
migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
POST/v1/users/{ssoId}/migration
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/migration' \
2
--request POST \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json'
PATCHNative REST
Update Migration Status
PATCH /v1/users/{ssoId}/migration
Update or postpone migration status.
Server
tc-customer
Operation ID
updateMigrationStatus
Called via
NetworkingProvider (native)
Authentication
BearerAuth Required
Headers
| Name | Type |
|---|
Authorization | Bearer {accessToken} |
device-id | string |
Content-Type | application/json |
Query Parameters
None (path params only).
Body
UpdateMigrationStatusRequest UpdateMigrationStatusRequest.swift
| Name | Type | | |
|---|
status | DataMigrationStatus | required | |
Responses
200 Success · StorageMigrationStatusResponse
StorageMigrationStatusResponse StorageMigrationStatusResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageMigrationStatusData | required | Expand StorageMigrationStatusDataStorageMigrationStatusData StorageMigrationStatusResponse.swift | Name | Type | | |
|---|
migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
|
StorageMigrationStatusData StorageMigrationStatusResponse.swift
| Name | Type | | |
|---|
migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
PATCH/v1/users/{ssoId}/migration
Shell Curl
1
curl 'https://drive-customer-api.trueid.net/drive/v1/users/{ssoId}/migration' \
2
--request PATCH \
3
--header 'Authorization: Bearer {accessToken}' \
4
--header 'device-id: {deviceId}' \
5
--header 'Content-Type: application/json' \
6
--data '{...}'
AWS S3 SDK
SDKAWS S3 SDK
transferUtility.upload
SDK /AWSS3TransferUtility.upload
Upload file bytes to S3 using credentials from STS. Not a True Cloud REST path.
Server
S3 endpoint from STS
Operation ID
transferUtility.upload
Called via
AWSS3TransferUtility
Authentication
BearerAuth Required
SDK
import AWSS3 · import AWSCore
Configured with TransferUtilityConfig from native getSecureTokenService.
Note
iOS AWS SDK call — use app code / TransferUtility, not browser.
SDKAWS S3 SDK
transferUtility.download
SDK /AWSS3TransferUtility.download
Download file bytes from S3 using credentials from STS. Not a True Cloud REST path.
Server
S3 endpoint from STS
Operation ID
transferUtility.download
Called via
AWSS3TransferUtility
Authentication
BearerAuth Required
SDK
import AWSS3 · import AWSCore
Configured with TransferUtilityConfig from native getSecureTokenService.
Note
iOS AWS SDK call — use app code / TransferUtility, not browser.
Schema Definitions
Models from Models/Request and Models/Response.
Request schemas
ChangeCoverObjectRequest ChangeCoverObjectRequest.swift
| Name | Type | | |
|---|
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
CompleteUploadRequest CompleteUploadRequest.swift
| Name | Type | | |
|---|
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
CreateFolderRequest CreateFolderRequest.swift
| Name | Type | | |
|---|
name | String | required | |
parent_object_id | String | required | |
DeleteObjectsRequest DeleteObjectsRequest.swift
| Name | Type | | |
|---|
accessToken | String | required | |
deviceId | String | required | |
ssoId | String | required | |
objectIds | [String] | required | |
EmptyTrashObjectsRequest EmptyTrashObjectsRequest.swift
| Name | Type | | |
|---|
accessToken | String | required | |
deviceId | String | required | |
ssoId | String | required | |
objectIds | [String] | required | |
GetObjectWithPreSignURLRequest GetObjectWithPreSignURLRequest.swift
| Name | Type | | |
|---|
presignUrl | Bool | required | |
GetObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
category | String | required | |
order | SortingOrder | required | |
GetRecentUploadRequest GetRecentUploadRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
GetSearchObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
category | String | required | |
order | SortingOrder | required | |
name | String | required | |
GetSearchRecentUploadRequest GetRecentUploadRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
name | String | required | |
GetSearchStorageObjectsRequest GetSearchStorageObjectsRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
name | String | required | |
GetStorageObjectsRequest GetStorageObjectsRequest.swift
| Name | Type | | |
|---|
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
GetTrashObjectsRequest GetTrashObjectsRequest.swift
| Name | Type | | |
|---|
accessToken | String | required | |
deviceId | String | required | |
ssoId | String | required | |
skip | Int | required | |
take | Int | required | |
order | SortingOrder | required | |
InitialUploadRequest InitialUploadRequest.swift
| Name | Type | | |
|---|
parent_object_id | String | required | |
name | String | required | |
mime_type | String | required | |
size | UInt64 | required | |
RestoreObjectsRequest RestoreObjectsRequest.swift
| Name | Type | | |
|---|
accessToken | String | required | |
deviceId | String | required | |
ssoId | String | required | |
objectIds | [String] | required | |
StorageInfoRequest StorageInfoRequest.swift
| Name | Type | | |
|---|
userId | String | required | |
UpdateMigrationStatusRequest UpdateMigrationStatusRequest.swift
| Name | Type | | |
|---|
status | DataMigrationStatus | required | |
UpdateSharedFileConfig UpdateSharedFileConfig.swift
| Name | Type | | |
|---|
is_private | Bool? | optional | |
password | String? | optional | |
is_new_password | Bool? | optional | |
expire_at | String? | optional | |
Response schemas
CopyObjectData CopyObjectResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
parent_object_id | String | required | |
name | String? | optional | |
shared_object_id | String? | optional | |
updated_at | String? | optional | |
created_at | String? | optional | |
CopyObjectResponse CopyObjectResponse.swift
| Name | Type | | |
|---|
code | Int | required | |
message | String | required | |
platform_module | Int | required | |
report_dashboard | Int | required | |
data | [CopyObjectData] | required | Expand CopyObjectDataCopyObjectData CopyObjectResponse.swift | Name | Type | | |
|---|
id | String? | optional | | parent_object_id | String | required | | name | String? | optional | | shared_object_id | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | |
|
DataUsageResponse DataUsageResponse.swift
| Name | Type | | |
|---|
audio | UInt64 | required | |
contacts | UInt64 | required | |
images | UInt64 | required | |
videos | UInt64 | required | |
others | UInt64 | required | |
total | UInt64 | required | |
usage_percent | Double | required | |
status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
DataUsageResponseStatus
| Case | Value |
|---|
almostFull | ALMOST_FULL |
available | AVAILABLE |
DeleteObjectsData DeleteObjectsResponse.swift
| Name | Type | | |
|---|
deleted | String | required | |
DeleteObjectsResponse DeleteObjectsResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | DeleteObjectsData | required | Expand DeleteObjectsDataDeleteObjectsData DeleteObjectsResponse.swift | Name | Type | | |
|---|
deleted | String | required | |
|
InfoResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
number_of_files | Int | required | |
InitialUploadData InitialUploadResponse.swift
| Name | Type | | |
|---|
id | String | required | |
object_type | StorageObjectType | required | |
parent_object_id | String? | optional | |
name | String | required | |
mime_type | String? | optional | |
category | FileCategory? | optional | |
size | UInt64 | required | |
is_uploaded | Bool | required | |
InitialUploadResponse InitialUploadResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | InitialUploadData | required | Expand InitialUploadDataInitialUploadData InitialUploadResponse.swift | Name | Type | | |
|---|
id | String | required | | object_type | StorageObjectType | required | | parent_object_id | String? | optional | | name | String | required | | mime_type | String? | optional | | category | FileCategory? | optional | | size | UInt64 | required | | is_uploaded | Bool | required | |
|
MediaObjectData MediaObjectResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
file_url | String? | optional | |
MediaObjectResponse MediaObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platformModule | Int? | optional | |
reportDashboard | Int? | optional | |
data | MediaObjectData | required | Expand MediaObjectDataMediaObjectData MediaObjectResponse.swift | Name | Type | | |
|---|
id | String? | optional | | file_url | String? | optional | |
|
MoveObjectData MoveObjectResponse.swift
| Name | Type | | |
|---|
count | Int? | optional | |
MoveObjectResponse MoveObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platform_module | Int? | optional | |
report_dashboard | Int? | optional | |
data | MoveObjectData | required | Expand MoveObjectDataMoveObjectData MoveObjectResponse.swift | Name | Type | | |
|---|
count | Int? | optional | |
|
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
| Name | Type | | |
|---|
updated | String | required | |
RemoveObjectsToTrashResponse MoveObjectsToTrashResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | RemoveObjectsToTrashData | required | Expand RemoveObjectsToTrashDataRemoveObjectsToTrashData MoveObjectsToTrashResponse.swift | Name | Type | | |
|---|
updated | String | required | |
|
RestoreObjectsData RestoreObjectsResponse.swift
| Name | Type | | |
|---|
updated | String | required | |
RestoreObjectsResponse RestoreObjectsResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | RestoreObjectsData | required | Expand RestoreObjectsDataRestoreObjectsData RestoreObjectsResponse.swift | Name | Type | | |
|---|
updated | String | required | |
|
SecureTokenServiceData SecureTokenServiceResponse.swift
| Name | Type | | |
|---|
access_token | String | required | |
secret_key | String | required | |
session_key | String | required | |
endpoint | String | required | |
expires_at | Date? | optional | |
SecureTokenServiceResponse SecureTokenServiceResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | SecureTokenServiceData | required | Expand SecureTokenServiceDataSecureTokenServiceData SecureTokenServiceResponse.swift | Name | Type | | |
|---|
access_token | String | required | | secret_key | String | required | | session_key | String | required | | endpoint | String | required | | expires_at | Date? | optional | |
|
ShareFileData ShareFileResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
is_private | Bool? | optional | |
password | String? | optional | |
expire_at | Date? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
shared_url | String? | optional | |
ShareFileResponse ShareFileResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
platform_module | Int? | optional | |
report_dashboard | Int? | optional | |
data | ShareFileData | required | Expand ShareFileDataShareFileData ShareFileResponse.swift | Name | Type | | |
|---|
id | String? | optional | | is_private | Bool? | optional | | password | String? | optional | | expire_at | Date? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | shared_url | String? | optional | |
|
SharedObject SharedObjectResponse.swift
| Name | Type | | |
|---|
file_url | String? | optional | |
id | String? | optional | |
object_type | String? | optional | |
category | FileCategory? | optional | |
cover_image_key | String? | optional | |
mime_type | String? | optional | |
name | String? | optional | |
updated_at | String? | optional | |
created_at | String? | optional | |
SharedObjectData SharedObjectResponse.swift
| Name | Type | | |
|---|
id | String? | optional | |
updated_at | String? | optional | |
created_at | String? | optional | |
object | SharedObject? | optional | Expand SharedObjectSharedObject SharedObjectResponse.swift | Name | Type | | |
|---|
file_url | String? | optional | | id | String? | optional | | object_type | String? | optional | | category | FileCategory? | optional | | cover_image_key | String? | optional | | mime_type | String? | optional | | name | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | |
|
SharedObjectLoginData SharedObjectLoginResponse.swift
| Name | Type | | |
|---|
shared_object_access_token | String? | optional | |
SharedObjectLoginResponse SharedObjectLoginResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | SharedObjectLoginData | required | Expand SharedObjectLoginDataSharedObjectLoginData SharedObjectLoginResponse.swift | Name | Type | | |
|---|
shared_object_access_token | String? | optional | |
|
SharedObjectResponse SharedObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | SharedObjectData | required | Expand SharedObjectDataSharedObjectData SharedObjectResponse.swift | Name | Type | | |
|---|
id | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | | object | SharedObject? | optional | Expand SharedObjectSharedObject SharedObjectResponse.swift | Name | Type | | |
|---|
file_url | String? | optional | | id | String? | optional | | object_type | String? | optional | | category | FileCategory? | optional | | cover_image_key | String? | optional | | mime_type | String? | optional | | name | String? | optional | | updated_at | String? | optional | | created_at | String? | optional | |
|
|
StorageInfoData StorageInfoResponse.swift
| Name | Type | | |
|---|
quota_size | UInt64 | required | |
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
root_folder | StorageObjectData? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
data_migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
StorageInfoResponse StorageInfoResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageInfoData? | optional | Expand StorageInfoDataStorageInfoData StorageInfoResponse.swift | Name | Type | | |
|---|
quota_size | UInt64 | required | | data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| root_folder | StorageObjectData? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| data_migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
|
StorageMigrationData StorageMigrationData.swift
| Name | Type | | |
|---|
status | DataMigrationStatus? | optional | |
estimated_time_to_complete | Date? | optional | |
failed_display_time | Int? | optional | |
expires_at | Date? | optional | |
StorageMigrationStatusData StorageMigrationStatusResponse.swift
| Name | Type | | |
|---|
migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
StorageMigrationStatusResponse StorageMigrationStatusResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageMigrationStatusData | required | Expand StorageMigrationStatusDataStorageMigrationStatusData StorageMigrationStatusResponse.swift | Name | Type | | |
|---|
migration | StorageMigrationData? | optional | Expand StorageMigrationDataStorageMigrationData StorageMigrationData.swift | Name | Type | | |
|---|
status | DataMigrationStatus? | optional | | estimated_time_to_complete | Date? | optional | | failed_display_time | Int? | optional | | expires_at | Date? | optional | |
|
|
StorageObjectData StorageObjectResponse.swift
| Name | Type | | |
|---|
id | String | required | |
parent_object_id | String? | optional | |
object_type | StorageObjectType | required | |
name | String | required | |
category | FileCategory? | optional | |
size | UInt64? | optional | |
mime_type | String? | optional | |
cover_image_key | String? | optional | |
cover_image_size | UInt64? | optional | |
updated_at | Date? | optional | |
created_at | Date? | optional | |
delete_in | Date? | optional | |
shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
StorageObjectListData StorageObjectResponse.swift
| Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
|
data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | Expand DataUsageResponseStatusDataUsageResponseStatus | Case | Value |
|---|
almostFull | ALMOST_FULL | available | AVAILABLE |
|
|
uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
folders | [FolderObjectModel] | required | |
items | [FolderObjectModel] | required | |
files | [FileObjectModel] | required | |
items | [FileObjectModel] | required | |
StorageObjectListResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectListData | required | Expand StorageObjectListDataStorageObjectListData StorageObjectResponse.swift | Name | Type | | |
|---|
info | InfoResponse? | optional | Expand InfoResponseInfoResponse StorageObjectResponse.swift | Name | Type | | |
|---|
number_of_files | Int | required | |
| data_usage | DataUsageResponse? | optional | Expand DataUsageResponseDataUsageResponse DataUsageResponse.swift | Name | Type | | |
|---|
audio | UInt64 | required | | contacts | UInt64 | required | | images | UInt64 | required | | videos | UInt64 | required | | others | UInt64 | required | | total | UInt64 | required | | usage_percent | Double | required | | status | DataUsageResponseStatus | required | |
| uploaded | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| uploading | [StorageObjectData]? | optional | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
| folders | [FolderObjectModel] | required | | items | [FolderObjectModel] | required | | files | [FileObjectModel] | required | | items | [FileObjectModel] | required | |
|
StorageObjectResponse StorageObjectResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | StorageObjectData | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
StorageSharedObject StorageObjectResponse.swift
| Name | Type | | |
|---|
is_private | Bool | required | |
TrashObjectListData TrashObjectListResponse.swift
| Name | Type | | |
|---|
uploaded | [StorageObjectData] | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | Expand StorageSharedObjectStorageSharedObject StorageObjectResponse.swift | Name | Type | | |
|---|
is_private | Bool | required | |
|
|
TrashObjectListResponse TrashObjectListResponse.swift
| Name | Type | | |
|---|
code | Int? | optional | |
message | String? | optional | |
data | TrashObjectListData | required | Expand TrashObjectListDataTrashObjectListData TrashObjectListResponse.swift | Name | Type | | |
|---|
uploaded | [StorageObjectData] | required | Expand StorageObjectDataStorageObjectData StorageObjectResponse.swift | Name | Type | | |
|---|
id | String | required | | parent_object_id | String? | optional | | object_type | StorageObjectType | required | | name | String | required | | category | FileCategory? | optional | | size | UInt64? | optional | | mime_type | String? | optional | | cover_image_key | String? | optional | | cover_image_size | UInt64? | optional | | updated_at | Date? | optional | | created_at | Date? | optional | | delete_in | Date? | optional | | shared_object | StorageSharedObject? | optional | |
|
|