apidocs: add missing authentication-related parameters (#3607)

This commit is contained in:
Alessandro Ros 2024-08-04 12:32:16 +02:00 committed by GitHub
parent 547e56e82b
commit c80bb53b0f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 41 additions and 21 deletions

View File

@ -1124,7 +1124,7 @@ Authentication can be delegated to an external HTTP server:
```yml
authMethod: http
externalAuthenticationURL: http://myauthserver/auth
authHTTPAddress: http://myauthserver/auth
```
Each time a user needs to be authenticated, the specified URL will be requested with the POST method and this payload:

View File

@ -21,6 +21,30 @@ components:
error:
type: string
AuthInternalUser:
type: object
properties:
user:
type: string
pass:
type: string
ips:
type: array
items:
type: string
permissions:
type: array
items:
$ref: '#/components/schemas/AuthInternalUserPermission'
AuthInternalUserPermission:
type: object
properties:
action:
type: string
path:
type: string
GlobalConf:
type: object
properties:
@ -41,8 +65,6 @@ components:
type: integer
udpMaxPayloadSize:
type: integer
externalAuthenticationURL:
type: string
runOnConnect:
type: string
runOnConnectRestart:
@ -50,6 +72,22 @@ components:
runOnDisconnect:
type: string
# Authentication
authMethod:
type: string
authInternalUsers:
type: array
items:
$ref: '#/components/schemas/AuthInternalUser'
authHTTPAddress:
type: string
authHTTPExclude:
type: array
items:
$ref: '#/components/schemas/AuthInternalUserPermission'
authJWTJWKS:
type: string
# Control API
api:
type: boolean
@ -295,24 +333,6 @@ components:
recordDeleteAfter:
type: string
# Authentication
publishUser:
type: string
publishPass:
type: string
publishIPs:
type: array
items:
type: string
readUser:
type: string
readPass:
type: string
readIPs:
type: array
items:
type: string
# Publisher source
overridePublisher:
type: boolean