Sign in
Authentication

Retrieve auth status

Get information about the current session, including whether the user has a password, and if the session can access locked assets.

get/auth/status

Request

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

Response

expiresAtstring

Session expiration date

isElevatedboolean required

Is elevated session

passwordboolean required

Has password set

pinCodeboolean required

Has PIN code set

pinExpiresAtstring

PIN expiration date

Changes

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