post/vault/token/exchange

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/vault/token/exchange
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

tokenstring required

The vault token (vtk_<hex>) to exchange for credential data

Response

OK

idstring required

Unique credential identifier

type'login' | 'secure_note' | 'card' | 'identity' | 'oauth_token' | 'api_key' | 'certificate' required

Credential type

namestring required

User-defined credential name

notesstring

Free-form notes attached to the credential

favoriteboolean required

Whether the credential is marked as a favorite

folderIdstring

Folder the credential belongs to

organizationIdstring

Organization the credential is scoped to

collectionIdsstring[]

Collections the credential is shared with

createdAtstring date-time required

Timestamp when the credential was created

updatedAtstring date-time required

Timestamp when the credential was last updated

revealPolicy'standard' | 'brokered'

Reveal policy governing whether plaintext may be returned (default 'standard')

Changes

No recorded changes to this operation across all 1 revision of this API.