openvidu/backend/openapi/components/schemas/internal/security-preferences.yaml

35 lines
1.2 KiB
YAML

type: object
properties:
authentication:
$ref: '#/AuthenticationPreferences'
description: Preferences for authentication.
AuthenticationPreferences:
type: object
properties:
authMethod:
type: object
properties:
type:
type: string
enum:
- single-user
default: single-user
example: single-user
description: |
Specifies the authentication method used to access the application.
- `single-user`: Only one user account exists, which has administrative privileges and is used for all access.
authModeToAccessRoom:
type: string
enum:
- none
- moderators_only
- all_users
default: none
example: none
description: |
Specifies who is required to authenticate before accessing a room:
- `none`: No authentication required.
- `moderators_only`: Only moderators need to authenticate.
- `all_users`: All users must authenticate.