-
Notifications
You must be signed in to change notification settings - Fork 46
Keychain Api
Marius David Wieschollek edited this page May 30, 2021
·
3 revisions
The keychain api allows the management of the client-side encryption keychains. This api is only available if the account has a challenge.
Action | Url | Method | Session required | Description |
---|---|---|---|---|
get | /api/1.0/keychain/get |
GET | yes | Fetch all keychains of the user |
set | /api/1.0/keychain/set |
POST | yes | Update or create a keychain |
The get action will return an object with all keychains.
There are no arguments for this action.
The success status code is 200 Ok
.
The request returns an object with the keychain type as properties and the encrypted keychain data as value of that property.
The format matches the one in of the keys
property from open session.
The set action will create or update a keychain.
Argument | Type | Default | Required | Description |
---|---|---|---|---|
id | string | - | yes | Id or type of the keychain |
data | string | - | yes | The encrypted keychain data |
The success status code is 200 Ok
.
The request returns an object with the property id and the keychain id / type as value.
- Keychains can only be created if a challenge is set