post/vault/credentials

Request

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

Request body

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

Type of credential to create

namestring required

Display name for the credential

notesstring

Free-form notes to attach

favoriteboolean

Mark the credential as a favorite

folderIdstring

Folder to place the credential in

organizationIdstring

Organization to scope the credential to

collectionIdsstring[]

Collections to share the credential with

revealPolicy'standard' | 'brokered'

Reveal policy for this credential. When omitted, agent-key-created logins default to 'brokered' and everything else follows the org's defaultRevealPolicy setting (itself defaulting to 'standard').

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.