Sign in
auth

Describe the presented session.

Changed on

Reports the acting principal and how this session authenticated — the assurance record the chokepoint consults, never what the account could have presented (human-auth ADR § Assurance).

get/api/v1/auth/whoami

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/auth/whoami
  • Auth: HTTP bearer

Response

The acting session.

enrolment_requiredboolean

True when this session authenticated by password on an instance whose second_factor policy is required and the account had no factor enrolled. Such a session is confined to factor enrolment, recovery-code generation, whoami, and logout at the authorization chokepoint until a factor stands. Absent or false otherwise.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • info

      added the required property / to the response with the status