5638025211
- Updated user login request body to define username and password directly instead of referencing an external schema. - Removed obsolete recording token request schema. - Added new request body for updating room anonymous access configuration. - Deleted outdated room guests request body. - Enhanced room member request body documentation for clarity on custom permissions. - Introduced new request body for updating room roles configuration. - Added error response schema for user ID already exists. - Created success response schema for retrieving authenticated user info. - Modified success response for retrieving multiple users to use userId instead of username. - Updated success response for room members to reflect changes in memberId and access URLs. - Adjusted success response for room details to include roles instead of guests. - Created success response for updating room anonymous access configuration. - Created success response for updating room roles configuration. - Revised meet-user schema to use userId instead of username and simplified role representation. - Deleted obsolete user-credentials schema. - Introduced meet-room-anonymous-config schema for anonymous access configuration. - Removed obsolete meet-room-guests schema. - Updated meet-room-member schema to clarify memberId and name usage. - Revised meet-room schema to replace guests with roles and added anonymous access configuration. - Updated OpenAPI paths to reflect changes in user and room management endpoints.
43 lines
1.8 KiB
YAML
43 lines
1.8 KiB
YAML
description: User creation options
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
userId:
|
|
type: string
|
|
pattern: '^[a-z0-9_]+$'
|
|
example: 'alice_smith'
|
|
description: |
|
|
The unique identifier for the new user. This must be unique across all users.
|
|
|
|
Validation: Must contain only lowercase letters, numbers, and underscores.
|
|
name:
|
|
type: string
|
|
maxLength: 50
|
|
example: 'Alice Smith'
|
|
description: |
|
|
The display name (profile name) for the user.
|
|
role:
|
|
type: string
|
|
enum: ['admin', 'user', 'room_member']
|
|
example: 'user'
|
|
description: |
|
|
The role to assign 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.
|
|
password:
|
|
type: string
|
|
format: password
|
|
minLength: 5
|
|
example: 'SecureP@ssw0rd'
|
|
description: |
|
|
The password for the new user account.
|
|
required:
|
|
- userId
|
|
- name
|
|
- role
|
|
- password
|