administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-03-27 02:28:22 +03:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

clarify auth endpoint return in openapi schema

Browse Source
This commit is contained in:
Josh Hawkins 2025-12-14 21:42:53 -06:00
parent 9e99cec52e
commit 0231d4474c
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/static/frigate-api.yaml vendored
View File

@ -17,20 +17,25 @@ paths:
summary: Authenticate request summary: Authenticate request
description: |- description: |-
Authenticates the current request based on proxy headers or JWT token. Authenticates the current request based on proxy headers or JWT token.
Returns user role and permissions for camera access.
This endpoint verifies authentication credentials and manages JWT token refresh. This endpoint verifies authentication credentials and manages JWT token refresh.
On success, no JSON body is returned; authentication state is communicated via response headers and cookies.
operationId: auth_auth_get operationId: auth_auth_get
responses: responses:
"200":
description: Successful Response
content:
application/json:
schema: {}
"202": "202":
description: Authentication Accepted description: Authentication Accepted (no response body, different headers depending on auth method)
content: headers:
application/json: remote-user:
schema: {} description: Authenticated username or "anonymous" in proxy-only mode
schema:
type: string
remote-role:
description: Resolved role (e.g., admin, viewer, or custom)
schema:
type: string
Set-Cookie:
description: May include refreshed JWT cookie ("frigate-token") when applicable
schema:
type: string
"401": "401":
description: Authentication Failed description: Authentication Failed
/profile: /profile: