Shares · Openfort Cold Storage API

Operations related to managing user shares

Get Share

GET/shares

Retrieves share details for the authenticated user

Header Parameters

X-Auth-ProviderRequired

string

Authentication provider type

Values

openfortcustom

X-Openfort-Provider

string

Openfort provider details (required when using third-party with Openfort)

X-Openfort-Token-Type

string

Openfort token type (required when using third-party with Openfort)

X-Encryption-Part

string

Encryption part for decrypting shares

X-Encryption-Session

string

Encryption session ID for secure operations

Responses

Register Share

POST/shares

Registers a new share for the authenticated user

Header Parameters

X-Auth-ProviderRequired

string

Authentication provider type

Values

openfortcustom

X-Openfort-Provider

string

Openfort provider details (required when using third-party with Openfort)

X-Openfort-Token-Type

string

Openfort token type (required when using third-party with Openfort)

X-Encryption-Part

string

Encryption part for decrypting shares

X-Encryption-Session

string

Encryption session ID for secure operations

X-User-ID

string

User ID for admin operations (when using API Key/Secret auth)

Request Body

application/json

secretRequired

string

The secret value to be stored

Examplesome_secret_value

entropyRequired

string

Encryption type for the share

Values

noneuserprojectpasskey

Exampleuser

salt

string

Salt used for encryption (required for user entropy)

Examplesome_salt_value

iterations

integer

Number of iterations for the key derivation

Example1000

length

integer

Length of the derived key

Example256

digest

string

Hashing algorithm used

Examplesha256

encryption_part

string

Encryption part for project entropy

Examplepart_value

encryption_session

string

Session ID for encryption operations

Examplesession_value

reference

string

External reference the share was stored under

Examplesig_019d0ab2-94e1-78eb-b311-ee4781bb97a5

storage_method_id

integer

Where the share is held. 0 shield, 1 Google Drive, 2 iCloud.

Values

012

Example0

passkey_reference

object

Passkey that protects the share. Set for passkey entropy only.

keychain_id

string

Keychain the share belongs to

Examplekc_1

Responses

201Share registered successfully

Update Share

PUT/shares

Updates an existing share for the authenticated user

Header Parameters

X-Auth-ProviderRequired

string

Authentication provider type

Values

openfortcustom

X-Openfort-Provider

string

Openfort provider details (required when using third-party with Openfort)

X-Openfort-Token-Type

string

Openfort token type (required when using third-party with Openfort)

X-Encryption-Part

string

Encryption part for decrypting shares

X-Encryption-Session

string

Encryption session ID for secure operations

Request Body

application/json

secretRequired

string

The secret value to be stored

Examplesome_secret_value

entropyRequired

string

Encryption type for the share

Values

noneuserprojectpasskey

Exampleuser

salt

string

Salt used for encryption (required for user entropy)

Examplesome_salt_value

iterations

integer

Number of iterations for the key derivation

Example1000

length

integer

Length of the derived key

Example256

digest

string

Hashing algorithm used

Examplesha256

encryption_part

string

Encryption part for project entropy

Examplepart_value

encryption_session

string

Session ID for encryption operations

Examplesession_value

reference

string

External reference the share was stored under

Examplesig_019d0ab2-94e1-78eb-b311-ee4781bb97a5

storage_method_id

integer

Where the share is held. 0 shield, 1 Google Drive, 2 iCloud.

Values

012

Example0

passkey_reference

object

Passkey that protects the share. Set for passkey entropy only.

keychain_id

string

Keychain the share belongs to

Examplekc_1

Responses

Delete Share

DELETE/shares

Deletes the share for the authenticated user

Header Parameters

X-Auth-ProviderRequired

string

Authentication provider type

Values

openfortcustom

X-Openfort-Provider

string

Openfort provider details (required when using third-party with Openfort)

X-Openfort-Token-Type

string

Openfort token type (required when using third-party with Openfort)

X-Encryption-Part

string

Encryption part for decrypting shares

X-Encryption-Session

string

Encryption session ID for secure operations

Responses

204Share deleted successfully

Get Share

Header Parameters

Responses

200Share details retrieved successfully

Show Child AttributesHide Child Attributes

401Unauthorized - Invalid or missing authentication credentials

404Not Found - The requested resource was not found

500Internal Server Error - An unexpected server error occurred

Register Share

Header Parameters

Request Body

Show Child AttributesHide Child Attributes

Responses

400Bad Request - Invalid request body or parameters

401Unauthorized - Invalid or missing authentication credentials

500Internal Server Error - An unexpected server error occurred

Update Share

Header Parameters

Request Body

Show Child AttributesHide Child Attributes

Responses

200Share updated successfully

Show Child AttributesHide Child Attributes

400Bad Request - Invalid request body or parameters

401Unauthorized - Invalid or missing authentication credentials

500Internal Server Error - An unexpected server error occurred

Delete Share

Header Parameters

Responses

401Unauthorized - Invalid or missing authentication credentials

404Not Found - The requested resource was not found

500Internal Server Error - An unexpected server error occurred