Herald
OpenapiAuth

Get authentication status

Returns the current session status including whether the user is authenticated, their user/realm IDs, and their permissions if valid session exists.

GET
/api/auth/{realmId}/status

Returns the current session status including whether the user is authenticated, their user/realm IDs, and their permissions if valid session exists.

Path Parameters

realmId*string

Realm ID

Response Body

application/json

application/json

curl -X GET "https://example.com/api/auth/string/status"
{  "authenticated": true,  "permissions": [    "string"  ],  "realmId": "string",  "userId": "string"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}