ArchAstro. V1. Status
(archastro v0.2.0)
Copy Markdown
Statu API resource.
Summary
Functions
Check API token status
Functions
@spec ping(ArchAstro.Client.t()) :: {:ok, ArchAstro.Types.StatusPing.t()} | {:error, ArchAstro.Error.reason()}
Check API token status
Returns the validity and metadata of the bearer token supplied in the request. Use this endpoint to verify that an API key or session token is present, active, and unexpired before making authenticated calls.
No authentication is required to call this endpoint — it accepts any request,
including those with no token at all. When a token is absent the token.status
field is "missing" and token.active is false. When a token is present but
invalid (expired, malformed, or referencing an unknown user) token.active is
false and token.status describes the failure reason. When the token is valid,
token.active is true, token.status is "active", and user is populated
with the authenticated user's profile.
Token validity details and, when the token is active, the authenticated user's profile.