mirror of
https://github.com/aler9/rtsp-simple-server
synced 2025-11-01 03:22:50 +08:00
apidocs: add missing authentication-related parameters (#3607)
This commit is contained in:
@@ -1124,7 +1124,7 @@ Authentication can be delegated to an external HTTP server:
|
|||||||
|
|
||||||
```yml
|
```yml
|
||||||
authMethod: http
|
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:
|
Each time a user needs to be authenticated, the specified URL will be requested with the POST method and this payload:
|
||||||
|
|||||||
@@ -21,6 +21,30 @@ components:
|
|||||||
error:
|
error:
|
||||||
type: string
|
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:
|
GlobalConf:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@@ -41,8 +65,6 @@ components:
|
|||||||
type: integer
|
type: integer
|
||||||
udpMaxPayloadSize:
|
udpMaxPayloadSize:
|
||||||
type: integer
|
type: integer
|
||||||
externalAuthenticationURL:
|
|
||||||
type: string
|
|
||||||
runOnConnect:
|
runOnConnect:
|
||||||
type: string
|
type: string
|
||||||
runOnConnectRestart:
|
runOnConnectRestart:
|
||||||
@@ -50,6 +72,22 @@ components:
|
|||||||
runOnDisconnect:
|
runOnDisconnect:
|
||||||
type: string
|
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
|
# Control API
|
||||||
api:
|
api:
|
||||||
type: boolean
|
type: boolean
|
||||||
@@ -295,24 +333,6 @@ components:
|
|||||||
recordDeleteAfter:
|
recordDeleteAfter:
|
||||||
type: string
|
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
|
# Publisher source
|
||||||
overridePublisher:
|
overridePublisher:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
|||||||
Reference in New Issue
Block a user