Skip to content
RunWisp

Check whether the caller is authenticated

GET
/api/auth/status
curl --request GET \
  --url http://localhost:9477/api/auth/status

Parameters

Section titled “Parameters”
Section titled “Cookie Parameters”
runwisp_jwt
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
authRequired
required

Whether authentication is required

boolean
authenticated
required

Whether the current request is already authenticated via cookie

boolean
readOnly
required

Whether the session was opened with the read-only password: it can view everything and change nothing

boolean

Example 

{
  "$schema": "http://localhost:9477/schemas/AuthStatusBody.json"
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "http://localhost:9477/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}