truecloud Server API Reference
Using True Cloud APIs
Download OpenAPI Home

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:

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

Native

All TrueCloudAPI / PhotoEditorAPI cases, including STS.

SDK

AWSS3TransferUtility 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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · StorageInfoResponse
StorageInfoResponse StorageInfoResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageInfoData?optional
Expand StorageInfoData
StorageInfoData StorageInfoResponse.swift
NameType
quota_sizeUInt64required
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
root_folderStorageObjectData?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
data_migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageInfoData StorageInfoResponse.swift
NameType
quota_sizeUInt64required
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
root_folderStorageObjectData?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
data_migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
GetStorageObjectsRequest GetStorageObjectsRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
Body

Empty / none.

Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectListDatarequired
Expand StorageObjectListData
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
GetObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
NameType
skipIntrequired
takeIntrequired
categoryStringrequired
orderSortingOrderrequired
Body

Empty / none.

Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectListDatarequired
Expand StorageObjectListData
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
GetRecentUploadRequest GetRecentUploadRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
Body

Empty / none.

Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectListDatarequired
Expand StorageObjectListData
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
GetObjectWithPreSignURLRequest GetObjectWithPreSignURLRequest.swift
NameType
presignUrlBoolrequired
Body

Empty / none.

Responses
200 Success · MediaObjectResponse
MediaObjectResponse MediaObjectResponse.swift
NameType
codeInt?optional
messageString?optional
platformModuleInt?optional
reportDashboardInt?optional
dataMediaObjectDatarequired
Expand MediaObjectData
MediaObjectData MediaObjectResponse.swift
NameType
idString?optional
file_urlString?optional
MediaObjectData MediaObjectResponse.swift
NameType
idString?optional
file_urlString?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
InitialUploadRequest InitialUploadRequest.swift
NameType
parent_object_idStringrequired
nameStringrequired
mime_typeStringrequired
sizeUInt64required
Responses
200 Success · InitialUploadResponse
InitialUploadResponse InitialUploadResponse.swift
NameType
codeInt?optional
messageString?optional
dataInitialUploadDatarequired
Expand InitialUploadData
InitialUploadData InitialUploadResponse.swift
NameType
idStringrequired
object_typeStorageObjectTyperequired
parent_object_idString?optional
nameStringrequired
mime_typeString?optional
categoryFileCategory?optional
sizeUInt64required
is_uploadedBoolrequired
InitialUploadData InitialUploadResponse.swift
NameType
idStringrequired
object_typeStorageObjectTyperequired
parent_object_idString?optional
nameStringrequired
mime_typeString?optional
categoryFileCategory?optional
sizeUInt64required
is_uploadedBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
(empty object)object
Responses
200 Success · InitialUploadResponse
InitialUploadResponse InitialUploadResponse.swift
NameType
codeInt?optional
messageString?optional
dataInitialUploadDatarequired
Expand InitialUploadData
InitialUploadData InitialUploadResponse.swift
NameType
idStringrequired
object_typeStorageObjectTyperequired
parent_object_idString?optional
nameStringrequired
mime_typeString?optional
categoryFileCategory?optional
sizeUInt64required
is_uploadedBoolrequired
InitialUploadData InitialUploadResponse.swift
NameType
idStringrequired
object_typeStorageObjectTyperequired
parent_object_idString?optional
nameStringrequired
mime_typeString?optional
categoryFileCategory?optional
sizeUInt64required
is_uploadedBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
CompleteUploadRequest CompleteUploadRequest.swift
NameType
cover_image_keyString?optional
cover_image_sizeUInt64?optional
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectDatarequired
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
ChangeCoverObjectRequest ChangeCoverObjectRequest.swift
NameType
cover_image_keyString?optional
cover_image_sizeUInt64?optional
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectDatarequired
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
CreateFolderRequest CreateFolderRequest.swift
NameType
nameStringrequired
parent_object_idStringrequired
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectDatarequired
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
namestring
Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectDatarequired
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectDatarequired
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
parent_object_idstring
object_idsstring[]
Responses
200 Success · MoveObjectResponse
MoveObjectResponse MoveObjectResponse.swift
NameType
codeInt?optional
messageString?optional
platform_moduleInt?optional
report_dashboardInt?optional
dataMoveObjectDatarequired
Expand MoveObjectData
MoveObjectData MoveObjectResponse.swift
NameType
countInt?optional
MoveObjectData MoveObjectResponse.swift
NameType
countInt?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
parent_object_idstring
object_idsstring[]
Responses
200 Success · CopyObjectResponse
CopyObjectResponse CopyObjectResponse.swift
NameType
codeIntrequired
messageStringrequired
platform_moduleIntrequired
report_dashboardIntrequired
data[CopyObjectData]required
Expand CopyObjectData
CopyObjectData CopyObjectResponse.swift
NameType
idString?optional
parent_object_idStringrequired
nameString?optional
shared_object_idString?optional
updated_atString?optional
created_atString?optional
CopyObjectData CopyObjectResponse.swift
NameType
idString?optional
parent_object_idStringrequired
nameString?optional
shared_object_idString?optional
updated_atString?optional
created_atString?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
object_idsstring[]
Responses
200 Success · RemoveObjectsToTrashResponse
RemoveObjectsToTrashResponse MoveObjectsToTrashResponse.swift
NameType
codeInt?optional
messageString?optional
dataRemoveObjectsToTrashDatarequired
Expand RemoveObjectsToTrashData
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
NameType
updatedStringrequired
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
NameType
updatedStringrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
(root)string[]
Responses
200 Success · RemoveObjectsToTrashResponse
RemoveObjectsToTrashResponse MoveObjectsToTrashResponse.swift
NameType
codeInt?optional
messageString?optional
dataRemoveObjectsToTrashDatarequired
Expand RemoveObjectsToTrashData
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
NameType
updatedStringrequired
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
NameType
updatedStringrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
NameType
sortstring
skipinteger
takeinteger
Body

Empty / none.

Responses
200 Success · TrashObjectListResponse
TrashObjectListResponse TrashObjectListResponse.swift
NameType
codeInt?optional
messageString?optional
dataTrashObjectListDatarequired
Expand TrashObjectListData
TrashObjectListData TrashObjectListResponse.swift
NameType
uploaded[StorageObjectData]required
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
TrashObjectListData TrashObjectListResponse.swift
NameType
uploaded[StorageObjectData]required
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
object_idsstring[]
Responses
200 Success · RestoreObjectsResponse
RestoreObjectsResponse RestoreObjectsResponse.swift
NameType
codeInt?optional
messageString?optional
dataRestoreObjectsDatarequired
Expand RestoreObjectsData
RestoreObjectsData RestoreObjectsResponse.swift
NameType
updatedStringrequired
RestoreObjectsData RestoreObjectsResponse.swift
NameType
updatedStringrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
object_idsstring[]
Responses
200 Success · DeleteObjectsResponse
DeleteObjectsResponse DeleteObjectsResponse.swift
NameType
codeInt?optional
messageString?optional
dataDeleteObjectsDatarequired
Expand DeleteObjectsData
DeleteObjectsData DeleteObjectsResponse.swift
NameType
deletedStringrequired
DeleteObjectsData DeleteObjectsResponse.swift
NameType
deletedStringrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
NameType
object_idsstring[]
Responses
200 Success · DeleteObjectsResponse
DeleteObjectsResponse DeleteObjectsResponse.swift
NameType
codeInt?optional
messageString?optional
dataDeleteObjectsDatarequired
Expand DeleteObjectsData
DeleteObjectsData DeleteObjectsResponse.swift
NameType
deletedStringrequired
DeleteObjectsData DeleteObjectsResponse.swift
NameType
deletedStringrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · ShareFileResponse
ShareFileResponse ShareFileResponse.swift
NameType
codeInt?optional
messageString?optional
platform_moduleInt?optional
report_dashboardInt?optional
dataShareFileDatarequired
Expand ShareFileData
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?optional
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · ShareFileResponse
ShareFileResponse ShareFileResponse.swift
NameType
codeInt?optional
messageString?optional
platform_moduleInt?optional
report_dashboardInt?optional
dataShareFileDatarequired
Expand ShareFileData
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?optional
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
UpdateSharedFileConfig UpdateSharedFileConfig.swift
NameType
is_privateBool?optional
passwordString?optional
is_new_passwordBool?optional
expire_atString?optional
Responses
200 Success · ShareFileResponse
ShareFileResponse ShareFileResponse.swift
NameType
codeInt?optional
messageString?optional
platform_moduleInt?optional
report_dashboardInt?optional
dataShareFileDatarequired
Expand ShareFileData
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?optional
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?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
NameType
AuthorizationBearer {sharedObjectAccessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · SharedObjectResponse
SharedObjectResponse SharedObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataSharedObjectDatarequired
Expand SharedObjectData
SharedObjectData SharedObjectResponse.swift
NameType
idString?optional
updated_atString?optional
created_atString?optional
objectSharedObject?optional
Expand SharedObject
SharedObject SharedObjectResponse.swift
NameType
file_urlString?optional
idString?optional
object_typeString?optional
categoryFileCategory?optional
cover_image_keyString?optional
mime_typeString?optional
nameString?optional
updated_atString?optional
created_atString?optional
SharedObjectData SharedObjectResponse.swift
NameType
idString?optional
updated_atString?optional
created_atString?optional
objectSharedObject?optional
Expand SharedObject
SharedObject SharedObjectResponse.swift
NameType
file_urlString?optional
idString?optional
object_typeString?optional
categoryFileCategory?optional
cover_image_keyString?optional
mime_typeString?optional
nameString?optional
updated_atString?optional
created_atString?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)
Authentication

No auth

Headers

No Authorization header.

Query Parameters

None (path params only).

Body
NameType
encrypted_shared_object_idstring
passwordstring
Responses
200 Success · SharedObjectLoginResponse
SharedObjectLoginResponse SharedObjectLoginResponse.swift
NameType
codeInt?optional
messageString?optional
dataSharedObjectLoginDatarequired
Expand SharedObjectLoginData
SharedObjectLoginData SharedObjectLoginResponse.swift
NameType
shared_object_access_tokenString?optional
SharedObjectLoginData SharedObjectLoginResponse.swift
NameType
shared_object_access_tokenString?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 '{...}'
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
GetSearchStorageObjectsRequest GetSearchStorageObjectsRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
nameStringrequired
Body

Empty / none.

Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectListDatarequired
Expand StorageObjectListData
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
GetSearchObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
NameType
skipIntrequired
takeIntrequired
categoryStringrequired
orderSortingOrderrequired
nameStringrequired
Body

Empty / none.

Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectListDatarequired
Expand StorageObjectListData
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters
GetSearchRecentUploadRequest GetRecentUploadRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
nameStringrequired
Body

Empty / none.

Responses
200 Success · StorageObjectListResponse
StorageObjectListResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectListDatarequired
Expand StorageObjectListData
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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'

Contact

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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · StorageObjectResponse
StorageObjectResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectDatarequired
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · SecureTokenServiceResponse
SecureTokenServiceResponse SecureTokenServiceResponse.swift
NameType
codeInt?optional
messageString?optional
dataSecureTokenServiceDatarequired
Expand SecureTokenServiceData
SecureTokenServiceData SecureTokenServiceResponse.swift
NameType
access_tokenStringrequired
secret_keyStringrequired
session_keyStringrequired
endpointStringrequired
expires_atDate?optional
SecureTokenServiceData SecureTokenServiceResponse.swift
NameType
access_tokenStringrequired
secret_keyStringrequired
session_keyStringrequired
endpointStringrequired
expires_atDate?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body

Empty / none.

Responses
200 Success · StorageMigrationStatusResponse
StorageMigrationStatusResponse StorageMigrationStatusResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageMigrationStatusDatarequired
Expand StorageMigrationStatusData
StorageMigrationStatusData StorageMigrationStatusResponse.swift
NameType
migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageMigrationStatusData StorageMigrationStatusResponse.swift
NameType
migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?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
NameType
AuthorizationBearer {accessToken}
device-idstring
Content-Typeapplication/json
Query Parameters

None (path params only).

Body
UpdateMigrationStatusRequest UpdateMigrationStatusRequest.swift
NameType
statusDataMigrationStatusrequired
Responses
200 Success · StorageMigrationStatusResponse
StorageMigrationStatusResponse StorageMigrationStatusResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageMigrationStatusDatarequired
Expand StorageMigrationStatusData
StorageMigrationStatusData StorageMigrationStatusResponse.swift
NameType
migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageMigrationStatusData StorageMigrationStatusResponse.swift
NameType
migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?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
NameType
cover_image_keyString?optional
cover_image_sizeUInt64?optional
CompleteUploadRequest CompleteUploadRequest.swift
NameType
cover_image_keyString?optional
cover_image_sizeUInt64?optional
CreateFolderRequest CreateFolderRequest.swift
NameType
nameStringrequired
parent_object_idStringrequired
DeleteObjectsRequest DeleteObjectsRequest.swift
NameType
accessTokenStringrequired
deviceIdStringrequired
ssoIdStringrequired
objectIds[String]required
EmptyTrashObjectsRequest EmptyTrashObjectsRequest.swift
NameType
accessTokenStringrequired
deviceIdStringrequired
ssoIdStringrequired
objectIds[String]required
GetObjectWithPreSignURLRequest GetObjectWithPreSignURLRequest.swift
NameType
presignUrlBoolrequired
GetObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
NameType
skipIntrequired
takeIntrequired
categoryStringrequired
orderSortingOrderrequired
GetRecentUploadRequest GetRecentUploadRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
GetSearchObjectsByCategoryRequest GetObjectsByCategoryRequest.swift
NameType
skipIntrequired
takeIntrequired
categoryStringrequired
orderSortingOrderrequired
nameStringrequired
GetSearchRecentUploadRequest GetRecentUploadRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
nameStringrequired
GetSearchStorageObjectsRequest GetSearchStorageObjectsRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
nameStringrequired
GetStorageObjectsRequest GetStorageObjectsRequest.swift
NameType
skipIntrequired
takeIntrequired
orderSortingOrderrequired
GetTrashObjectsRequest GetTrashObjectsRequest.swift
NameType
accessTokenStringrequired
deviceIdStringrequired
ssoIdStringrequired
skipIntrequired
takeIntrequired
orderSortingOrderrequired
InitialUploadRequest InitialUploadRequest.swift
NameType
parent_object_idStringrequired
nameStringrequired
mime_typeStringrequired
sizeUInt64required
RestoreObjectsRequest RestoreObjectsRequest.swift
NameType
accessTokenStringrequired
deviceIdStringrequired
ssoIdStringrequired
objectIds[String]required
StorageInfoRequest StorageInfoRequest.swift
NameType
userIdStringrequired
UpdateMigrationStatusRequest UpdateMigrationStatusRequest.swift
NameType
statusDataMigrationStatusrequired
UpdateSharedFileConfig UpdateSharedFileConfig.swift
NameType
is_privateBool?optional
passwordString?optional
is_new_passwordBool?optional
expire_atString?optional

Response schemas

CopyObjectData CopyObjectResponse.swift
NameType
idString?optional
parent_object_idStringrequired
nameString?optional
shared_object_idString?optional
updated_atString?optional
created_atString?optional
CopyObjectResponse CopyObjectResponse.swift
NameType
codeIntrequired
messageStringrequired
platform_moduleIntrequired
report_dashboardIntrequired
data[CopyObjectData]required
Expand CopyObjectData
CopyObjectData CopyObjectResponse.swift
NameType
idString?optional
parent_object_idStringrequired
nameString?optional
shared_object_idString?optional
updated_atString?optional
created_atString?optional
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
DeleteObjectsData DeleteObjectsResponse.swift
NameType
deletedStringrequired
DeleteObjectsResponse DeleteObjectsResponse.swift
NameType
codeInt?optional
messageString?optional
dataDeleteObjectsDatarequired
Expand DeleteObjectsData
DeleteObjectsData DeleteObjectsResponse.swift
NameType
deletedStringrequired
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
InitialUploadData InitialUploadResponse.swift
NameType
idStringrequired
object_typeStorageObjectTyperequired
parent_object_idString?optional
nameStringrequired
mime_typeString?optional
categoryFileCategory?optional
sizeUInt64required
is_uploadedBoolrequired
InitialUploadResponse InitialUploadResponse.swift
NameType
codeInt?optional
messageString?optional
dataInitialUploadDatarequired
Expand InitialUploadData
InitialUploadData InitialUploadResponse.swift
NameType
idStringrequired
object_typeStorageObjectTyperequired
parent_object_idString?optional
nameStringrequired
mime_typeString?optional
categoryFileCategory?optional
sizeUInt64required
is_uploadedBoolrequired
MediaObjectData MediaObjectResponse.swift
NameType
idString?optional
file_urlString?optional
MediaObjectResponse MediaObjectResponse.swift
NameType
codeInt?optional
messageString?optional
platformModuleInt?optional
reportDashboardInt?optional
dataMediaObjectDatarequired
Expand MediaObjectData
MediaObjectData MediaObjectResponse.swift
NameType
idString?optional
file_urlString?optional
MoveObjectData MoveObjectResponse.swift
NameType
countInt?optional
MoveObjectResponse MoveObjectResponse.swift
NameType
codeInt?optional
messageString?optional
platform_moduleInt?optional
report_dashboardInt?optional
dataMoveObjectDatarequired
Expand MoveObjectData
MoveObjectData MoveObjectResponse.swift
NameType
countInt?optional
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
NameType
updatedStringrequired
RemoveObjectsToTrashResponse MoveObjectsToTrashResponse.swift
NameType
codeInt?optional
messageString?optional
dataRemoveObjectsToTrashDatarequired
Expand RemoveObjectsToTrashData
RemoveObjectsToTrashData MoveObjectsToTrashResponse.swift
NameType
updatedStringrequired
RestoreObjectsData RestoreObjectsResponse.swift
NameType
updatedStringrequired
RestoreObjectsResponse RestoreObjectsResponse.swift
NameType
codeInt?optional
messageString?optional
dataRestoreObjectsDatarequired
Expand RestoreObjectsData
RestoreObjectsData RestoreObjectsResponse.swift
NameType
updatedStringrequired
SecureTokenServiceData SecureTokenServiceResponse.swift
NameType
access_tokenStringrequired
secret_keyStringrequired
session_keyStringrequired
endpointStringrequired
expires_atDate?optional
SecureTokenServiceResponse SecureTokenServiceResponse.swift
NameType
codeInt?optional
messageString?optional
dataSecureTokenServiceDatarequired
Expand SecureTokenServiceData
SecureTokenServiceData SecureTokenServiceResponse.swift
NameType
access_tokenStringrequired
secret_keyStringrequired
session_keyStringrequired
endpointStringrequired
expires_atDate?optional
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?optional
ShareFileResponse ShareFileResponse.swift
NameType
codeInt?optional
messageString?optional
platform_moduleInt?optional
report_dashboardInt?optional
dataShareFileDatarequired
Expand ShareFileData
ShareFileData ShareFileResponse.swift
NameType
idString?optional
is_privateBool?optional
passwordString?optional
expire_atDate?optional
updated_atDate?optional
created_atDate?optional
shared_urlString?optional
SharedObject SharedObjectResponse.swift
NameType
file_urlString?optional
idString?optional
object_typeString?optional
categoryFileCategory?optional
cover_image_keyString?optional
mime_typeString?optional
nameString?optional
updated_atString?optional
created_atString?optional
SharedObjectData SharedObjectResponse.swift
NameType
idString?optional
updated_atString?optional
created_atString?optional
objectSharedObject?optional
Expand SharedObject
SharedObject SharedObjectResponse.swift
NameType
file_urlString?optional
idString?optional
object_typeString?optional
categoryFileCategory?optional
cover_image_keyString?optional
mime_typeString?optional
nameString?optional
updated_atString?optional
created_atString?optional
SharedObjectLoginData SharedObjectLoginResponse.swift
NameType
shared_object_access_tokenString?optional
SharedObjectLoginResponse SharedObjectLoginResponse.swift
NameType
codeInt?optional
messageString?optional
dataSharedObjectLoginDatarequired
Expand SharedObjectLoginData
SharedObjectLoginData SharedObjectLoginResponse.swift
NameType
shared_object_access_tokenString?optional
SharedObjectResponse SharedObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataSharedObjectDatarequired
Expand SharedObjectData
SharedObjectData SharedObjectResponse.swift
NameType
idString?optional
updated_atString?optional
created_atString?optional
objectSharedObject?optional
Expand SharedObject
SharedObject SharedObjectResponse.swift
NameType
file_urlString?optional
idString?optional
object_typeString?optional
categoryFileCategory?optional
cover_image_keyString?optional
mime_typeString?optional
nameString?optional
updated_atString?optional
created_atString?optional
StorageInfoData StorageInfoResponse.swift
NameType
quota_sizeUInt64required
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
root_folderStorageObjectData?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
data_migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageInfoResponse StorageInfoResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageInfoData?optional
Expand StorageInfoData
StorageInfoData StorageInfoResponse.swift
NameType
quota_sizeUInt64required
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
root_folderStorageObjectData?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
data_migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageMigrationStatusData StorageMigrationStatusResponse.swift
NameType
migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageMigrationStatusResponse StorageMigrationStatusResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageMigrationStatusDatarequired
Expand StorageMigrationStatusData
StorageMigrationStatusData StorageMigrationStatusResponse.swift
NameType
migrationStorageMigrationData?optional
Expand StorageMigrationData
StorageMigrationData StorageMigrationData.swift
NameType
statusDataMigrationStatus?optional
estimated_time_to_completeDate?optional
failed_display_timeInt?optional
expires_atDate?optional
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
Expand DataUsageResponseStatus
DataUsageResponseStatus
CaseValue
almostFullALMOST_FULL
availableAVAILABLE
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectListResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectListDatarequired
Expand StorageObjectListData
StorageObjectListData StorageObjectResponse.swift
NameType
infoInfoResponse?optional
Expand InfoResponse
InfoResponse StorageObjectResponse.swift
NameType
number_of_filesIntrequired
data_usageDataUsageResponse?optional
Expand DataUsageResponse
DataUsageResponse DataUsageResponse.swift
NameType
audioUInt64required
contactsUInt64required
imagesUInt64required
videosUInt64required
othersUInt64required
totalUInt64required
usage_percentDoublerequired
statusDataUsageResponseStatusrequired
uploaded[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
uploading[StorageObjectData]?optional
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
folders[FolderObjectModel]required
items[FolderObjectModel]required
files[FileObjectModel]required
items[FileObjectModel]required
StorageObjectResponse StorageObjectResponse.swift
NameType
codeInt?optional
messageString?optional
dataStorageObjectDatarequired
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
TrashObjectListData TrashObjectListResponse.swift
NameType
uploaded[StorageObjectData]required
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional
Expand StorageSharedObject
StorageSharedObject StorageObjectResponse.swift
NameType
is_privateBoolrequired
TrashObjectListResponse TrashObjectListResponse.swift
NameType
codeInt?optional
messageString?optional
dataTrashObjectListDatarequired
Expand TrashObjectListData
TrashObjectListData TrashObjectListResponse.swift
NameType
uploaded[StorageObjectData]required
Expand StorageObjectData
StorageObjectData StorageObjectResponse.swift
NameType
idStringrequired
parent_object_idString?optional
object_typeStorageObjectTyperequired
nameStringrequired
categoryFileCategory?optional
sizeUInt64?optional
mime_typeString?optional
cover_image_keyString?optional
cover_image_sizeUInt64?optional
updated_atDate?optional
created_atDate?optional
delete_inDate?optional
shared_objectStorageSharedObject?optional