Authentication

Endpointhttps://api.neuratel.ai

User authentication and session management.

Get Current Auth Context

GET

https://api.neuratel.ai

/v1/auth/me

Return authentication context for the current user.

Get Current Auth Context › Responses

200

Successful Response

Authentication context for the current user. This is the main response from /auth/me endpoint. Frontend uses scopes to determine UI permissions.

email

string · required

user_id

string · required

User identifier from auth provider

role

string · enum

Effective role

Enum values:

super_admin

admin

operator

viewer

Default: viewer

effective_role

string

String version of effective role for frontend

Default: viewer

is_super_admin

boolean

Whether user has super admin access

Default: false

scopes

string[]

Permission scopes from JWT

authenticated_via

string

jwt or api_key

Default: jwt

Check Resource Permissions

GET

https://api.neuratel.ai

/v1/auth/permissions/{resource}

Check CRUD permissions for a specific resource.

Check Resource Permissions › path Parameters

resource

string · required

Check Resource Permissions › Responses

Successful Response

Update Profile

PATCH

https://api.neuratel.ai

/v1/auth/profile

Update user display name and/or avatar.

Update Profile › Request Body

Update Profile › Responses

Successful Response

Get Ws Token

GET

https://api.neuratel.ai

/v1/auth/ws-token

Issue a short-lived HS256 JWT (5 min) for WebSocket authentication. WebSocket connections cannot send HttpOnly session cookies, so they request a one-time token here and pass it as ?token= query param.

Get Ws Token › Responses

200

Successful Response

Knowledge Base API Keys

Get Current Auth Context

GET

https://api.neuratel.ai

/v1/auth/me

Return authentication context for the current user.

Get Current Auth Context › Responses

200

Successful Response

Authentication context for the current user. This is the main response from /auth/me endpoint. Frontend uses scopes to determine UI permissions.

email

string · required

user_id

string · required

User identifier from auth provider

role

string · enum

Effective role

Enum values:

super_admin

admin

operator

viewer

Default: viewer

effective_role

string

String version of effective role for frontend

Default: viewer

is_super_admin

boolean

Whether user has super admin access

Default: false

scopes

string[]

Permission scopes from JWT

authenticated_via

string

jwt or api_key

Default: jwt

Get Ws Token

GET

https://api.neuratel.ai

/v1/auth/ws-token

Get Ws Token › Responses

200

Successful Response