27 lines
1.1 KiB
YAML

type: object
properties:
userId:
type: string
example: 'alice_smith'
description: |
The unique identifier of the user.
name:
type: string
example: 'Alice Smith'
description: |
The display name (profile name) of the user.
registrationDate:
type: number
example: 1620000000000
description: |
The registration date of the user in milliseconds since the Unix epoch.
role:
type: string
enum: ['admin', 'user', 'room_member']
example: 'user'
description: |
The role assigned to the user. Available roles:
- admin: Has full control over the entire application (configuration, users, rooms, recordings, etc).
- user: Can create and manage their own created rooms and associated recordings. Can also access rooms they are a member of, but without management permissions.
- room_member: Can only access rooms (and recordings) they are a member of, without ability to create or manage rooms.