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.
142 lines
5.4 KiB
YAML
142 lines
5.4 KiB
YAML
/users:
|
|
post:
|
|
operationId: createUser
|
|
summary: Create a new user
|
|
description: |
|
|
Creates a new user account in the system.
|
|
|
|
The userId must be unique. If a user with the specified userId already exists,
|
|
the request will fail with a conflict error.
|
|
tags:
|
|
- Internal API - Users
|
|
security:
|
|
- accessTokenHeader: []
|
|
requestBody:
|
|
$ref: '../../components/requestBodies/internal/create-user-request.yaml'
|
|
responses:
|
|
'201':
|
|
$ref: '../../components/responses/internal/success-create-user.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'409':
|
|
$ref: '../../components/responses/internal/error-userId-already-exists.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
get:
|
|
operationId: getUsers
|
|
summary: Get all users
|
|
description: >
|
|
Retrieves a paginated list of all users in the system.
|
|
tags:
|
|
- Internal API - Users
|
|
security:
|
|
- accessTokenHeader: []
|
|
parameters:
|
|
- $ref: '../../components/parameters/max-items.yaml'
|
|
- $ref: '../../components/parameters/next-page-token.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-get-users.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
/users/me:
|
|
get:
|
|
operationId: getMe
|
|
summary: Get authenticated user
|
|
description: >
|
|
Retrieves the details of the authenticated user.
|
|
tags:
|
|
- Internal API - Users
|
|
security:
|
|
- accessTokenHeader: []
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-get-me.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
/users/change-password:
|
|
post:
|
|
operationId: changeUserPassword
|
|
summary: Change user password
|
|
description: >
|
|
Allows the authenticated user to change their password.
|
|
tags:
|
|
- Internal API - Users
|
|
security:
|
|
- accessTokenHeader: []
|
|
requestBody:
|
|
$ref: '../../components/requestBodies/internal/change-password-request.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-change-password.yaml'
|
|
'400':
|
|
$ref: '../../components/responses/internal/error-invalid-password.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
/users/{userId}:
|
|
get:
|
|
operationId: getUser
|
|
summary: Get a user
|
|
description: >
|
|
Retrieves the details of a specific user by their userId.
|
|
tags:
|
|
- Internal API - Users
|
|
security:
|
|
- accessTokenHeader: []
|
|
parameters:
|
|
- $ref: '../../components/parameters/internal/userId-path.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-get-user.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/internal/error-user-not-found.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
delete:
|
|
operationId: deleteUser
|
|
summary: Delete a user
|
|
description: |
|
|
Deletes a user from the system.
|
|
|
|
This operation will remove the user account and may affect rooms and resources
|
|
associated with this user.
|
|
tags:
|
|
- Internal API - Users
|
|
security:
|
|
- accessTokenHeader: []
|
|
parameters:
|
|
- $ref: '../../components/parameters/internal/userId-path.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-delete-user.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/internal/error-user-not-found.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|