Skip to content
LogoLogo

Shares

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
noneuserproject
Exampleuser
salt
string

Salt used for encryption (required for user entropy)

Examplesome_salt_value
iterations
integer

Number of iterations for encryption algorithm

Example1000
length
integer

Length of the encrypted data

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

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 updated secret value

Exampleupdated_secret_value
entropyRequired
string

Encryption type for the share

Values
noneuserproject
Exampleproject
salt
string

Updated salt for encryption

Exampleupdated_salt_value
iterations
integer

Updated number of iterations

Example2000
length
integer

Updated length of encrypted data

Example512
digest
string

Updated hashing algorithm

Examplesha512
encryption_part
string

Updated encryption part

Exampleupdated_part_value
encryption_session
string

Updated session ID

Exampleupdated_session_value

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

Presented By