REST endpoints
Path | Middleware | Input | Output | Notes |
---|---|---|---|---|
GET /folder/{folderId} | authdQuery | FolderResponse | ||
POST /accounts/{accountId}/secrets/{secretId}/keylist/{key} | authdQuery | U2FResponseBundle | SecretKeylistKey | |
GET /accounts/{accountId}/secrets/{secretId}/keylist/{key}/challenge | authdQuery | U2FChallengeBundle | ||
POST /accounts/{accountId}/secrets | authdQuery | U2FResponseBundle | ExposedSecret[] | |
GET /accounts/{accountId}/secrets/{secretId}/totp_barcode?mac={mac} | authdQuery | Gets QR code of TOTP token for exporting to Google Authenticator | ||
GET /auditlog | authdQuery | AuditlogEntry[] | ||
GET /accounts/{id} | authdQuery | WrappedAccount | ||
GET /search?q={query} | authdQuery | FolderResponse | ||
GET /u2f/enrollment/challenge | authdQuery | U2FEnrollmentChallenge | ||
GET /u2f/enrolled_tokens | authdQuery | U2FEnrolledToken[] |
Datatypes are as follows:
type FolderResponse
Key | Type |
---|---|
Folder | Folder | null |
SubFolders | Folder[] |
ParentFolders | Folder[] |
Accounts | Account[] |
type Account
Key | Type |
---|---|
Id | string |
Created | string |
FolderId | string |
Title | string |
Url | string |
Username | string |
Description | string |
type WrappedAccount
Key | Type |
---|---|
Account | Account |
ChallengeBundle | U2FChallengeBundle |
type U2FChallengeBundle
Key | Type |
---|---|
SignRequest | U2FSignRequest |
Challenge | U2FChallenge |
type U2FChallenge
Key | Type |
---|---|
Challenge | string |
Timestamp | string |
AppID | string |
TrustedFacets | string[] |
type U2FSignRequest
Key | Type |
---|---|
AppID | string |
Challenge | string |
RegisteredKeys | U2FRegisteredKey[] |
type U2FRegisteredKey
Key | Type |
---|---|
Version | string |
KeyHandle | string |
AppID | string |
type Folder
Key | Type |
---|---|
Id | string |
ParentId | string |
Name | string |
type AuditlogEntry
Key | Type |
---|---|
Timestamp | string |
Message | string |
type Secret
Key | Type |
---|---|
Id | string |
Kind | SecretKind |
Title | string |
Created | string |
Password | string |
SshPublicKeyAuthorized | string |
KeylistKeyExample | string |
Note | string |
type ExposedSecret
Key | Type |
---|---|
Secret | Secret |
OtpProof | string |
OtpKeyExportMac | string |
OtpProofTime | string |
type SecretKeylistKey
Key | Type |
---|---|
Key | string |
Value | string |
type U2FResponseBundle
Key | Type |
---|---|
SignResult | U2FSignResult |
Challenge | U2FChallenge |
type U2FSignResult
Key | Type |
---|---|
KeyHandle | string |
SignatureData | string |
ClientData | string |
type RegisterResponse
Key | Type |
---|---|
Challenge | U2FChallenge |
RegisterResponse | U2FRegisterResponse |
type U2FEnrolledToken
Key | Type |
---|---|
EnrolledAt | string |
Name | string |
Version | string |
type U2FRegisterResponse
Key | Type |
---|---|
Version | string |
RegistrationData | string |
ClientData | string |
type U2FEnrollmentChallenge
Key | Type |
---|---|
Challenge | U2FChallenge |
RegisterRequest | U2FWebRegisterRequest |
type U2FRegisterRequest
Key | Type |
---|---|
Version | string |
Challenge | string |
type U2FWebRegisterRequest
Key | Type |
---|---|
AppID | string |
RegisterRequests | U2FRegisterRequest[] |
RegisteredKeys | U2FRegisteredKey[] |