Sign in
Authentication

Unlock auth session

Temporarily grant the session elevated access to locked assets by providing the correct PIN code.

post/auth/session/unlock

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/auth/session/unlock
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Request body

passwordstring

User password (required if PIN code is not provided)

pinCodestring

New PIN code (4-6 digits)

Example request

{
  "password": "password",
  "pinCode": "123456"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.