Skip to content
Authrim

Read Account Page reauthentication status.

GET
/api/account/reauth/status
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/account/reauth/status \
  --cookie authrim_session=<authrim_session>

Returns whether sensitive Account Page operations currently require reauthentication. The reauthentication window runs from the session auth_time for the tenant’s re-authentication window (self-service.reauth_ttl_seconds, 60-1800 seconds, default 300); ttl_seconds reports it.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Account Page reauthentication status response.

Media type application/json
object
reauth
required
object
required
required
boolean
authenticated_at
required
integer
expires_at
required
integer
ttl_seconds
required
integer
methods
required
Array<string>
Example generated
{
  "reauth": {
    "required": true,
    "authenticated_at": 1,
    "expires_at": 1,
    "ttl_seconds": 1,
    "methods": [
      "example"
    ]
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}