logins

Change a saved login

Changes a saved login's fields and returns the changed login.

  • A field left out is kept; null clears an optional one. The website and the sign-in type (password or code) never change.
  • On a password login, changing label, username, primary_identifier or authenticator_secret also needs password.
  • The values pass through this client and its model provider. Warn the user first, or send only deliver "dashboard" to get the login's Dashboard edit page instead.
patch/v1/logins/{id}

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/logins/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:login_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

a saved login ID: login_ and 32 lowercase hex digits

Request body

labelstring nullable

a string at most 200 character(s) long

usernamestring

a string at most 1024 character(s) long

emailstring nullable

a string at most 320 character(s) long

phonestring nullable

a string at most 64 character(s) long

account_numberstring nullable

a string at most 128 character(s) long

primary_identifier'username' | 'email' | 'phone' | 'account_number'

The identifier it signs in with; else the first it holds in this order

passwordstring

a string at most 16384 character(s) long

date_of_birthstring nullable

a string matching the pattern ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

zipstring nullable

a string at most 10 character(s) long

authenticator_secretstring nullable

a string at most 4096 character(s) long

recovery_codesstring[] nullable

an array of at most 20 item(s)

preferred_method'sms' | 'call' | 'email' | 'authenticator' | 'push' | 'recovery_code' nullable

A two-factor method

deliver'dashboard'

Return a Dashboard link where the person enters the login, so no secret reaches this client

Response

The changed login; With deliver dashboard: where to finish

OR

Example response

{
  "id": "login_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
}

Changes

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