Overview
| Endpoint | Middleware | Title |
|---|---|---|
| POST /command/account.Rename | authdWrite | Rename account |
| POST /command/account.Move | authdWrite | Move account to different folder |
| POST /command/account.ChangeUsername | authdWrite | Change username |
| POST /command/account.ChangeDescription | authdWrite | Change description |
| POST /command/account.ChangeUrl | authdWrite | Change URL |
| POST /command/account.DeleteSecret | authdWrite | Delete secret |
| POST /command/account.CreateFolder | authdWrite | + Folder |
| POST /command/account.DeleteFolder | authdWrite | Delete folder |
| POST /command/account.RenameFolder | authdWrite | Rename |
| POST /command/account.MoveFolder | authdWrite | Move |
| POST /command/account.Create | authdWrite | + Account |
| POST /command/account.Delete | authdWrite | Delete |
| POST /command/account.AddPassword | authdWrite | + Password |
| POST /command/account.AddKeylist | authdWrite | + Keylist |
| POST /command/account.AddSshKey | authdWrite | + SSH key |
| POST /command/account.AddSecretNote | authdWrite | + Secret note |
| POST /command/account.AddOtpToken | authdWrite | Add OTP token |
| POST /command/database.ChangeMasterPassword | authdWrite | Change master password |
| POST /command/session.SignIn | public | Sign in |
| POST /command/session.SignOut | authdWrite | Sign out |
| POST /command/database.Unseal | public | Unseal database |
| POST /command/database.ExportToKeepass | authdWrite | Export to KeePass format |
| POST /command/user.Create | authdWrite | + User |
| POST /command/user.RegisterU2FToken | authdWrite | Register U2F token |
account.Rename
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Title | text | true |
account.Move
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| NewParentFolder | text | true |
account.ChangeUsername
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Username | text | true |
account.ChangeDescription
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Description | multiline | false |
account.ChangeUrl
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Url | text | false |
account.DeleteSecret
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Secret | text | true |
account.CreateFolder
| Field | Type | Required | Notes |
|---|---|---|---|
| Parent | text | true | |
| Name | text | true |
account.DeleteFolder
| Field | Type | Required | Notes |
|---|---|---|---|
| Id | text | true |
account.RenameFolder
| Field | Type | Required | Notes |
|---|---|---|---|
| Id | text | true | |
| Name | text | true |
account.MoveFolder
| Field | Type | Required | Notes |
|---|---|---|---|
| Id | text | true | |
| NewParent | text | true |
account.Create
| Field | Type | Required | Notes |
|---|---|---|---|
| FolderId | text | true | |
| Title | text | false | If you don`t specify this, then URL is required |
| Url | text | false | If you don`t specify this, then Title is required |
| Username | text | false | |
| Password | password | false | |
| PasswordRepeat | password | false |
account.Delete
| Field | Type | Required | Notes |
|---|---|---|---|
| Id | text | true |
account.AddPassword
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Password | password | true | Enter "_auto" to autogenerate one |
| PasswordRepeat | password | true |
account.AddKeylist
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Title | text | true | |
| ExpectedKeyCount | integer | true | |
| LengthOfKeys | integer | true | |
| LengthOfValues | integer | true | |
| Keylist | multiline | true |
account.AddSshKey
| Field | Type | Required | Notes |
|---|---|---|---|
| Id | text | true | |
| SshPrivateKey | multiline | true |
account.AddSecretNote
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| Title | text | true | |
| Note | multiline | true |
account.AddOtpToken
| Field | Type | Required | Notes |
|---|---|---|---|
| Account | text | true | |
| OtpProvisioningUrl | text | true |
database.ChangeMasterPassword
| Field | Type | Required | Notes |
|---|---|---|---|
| NewMasterPassword | password | true | |
| NewMasterPasswordRepeat | password | true |
session.SignIn
| Field | Type | Required | Notes |
|---|---|---|---|
| Username | text | true | |
| Password | password | true |
session.SignOut
| Field | Type | Required | Notes |
|---|
database.Unseal
| Field | Type | Required | Notes |
|---|---|---|---|
| MasterPassword | password | true |
database.ExportToKeepass
| Field | Type | Required | Notes |
|---|
user.Create
| Field | Type | Required | Notes |
|---|
user.RegisterU2FToken
| Field | Type | Required | Notes |
|---|---|---|---|
| Request | text | true | |
| Name | text | true |