76 lines
3.3 KiB
YAML
76 lines
3.3 KiB
YAML
/rooms/{roomId}/token:
|
|
post:
|
|
operationId: generateRoomMemberToken
|
|
summary: Generate room member token
|
|
description: >
|
|
Generates a token for a user to access an OpenVidu Meet room and its resources.
|
|
tags:
|
|
- Internal API - Rooms
|
|
security:
|
|
- accessTokenHeader: []
|
|
parameters:
|
|
- $ref: '../../components/parameters/room-id-path.yaml'
|
|
requestBody:
|
|
$ref: '../../components/requestBodies/internal/room-member-token-request.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-generate-room-member-token.yaml'
|
|
'400':
|
|
$ref: '../../components/responses/internal/error-invalid-room-secret.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/internal/error-room-participant-not-found.yaml'
|
|
'409':
|
|
$ref: '../../components/responses/internal/error-room-closed.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
/rooms/{roomId}/roles:
|
|
get:
|
|
operationId: getRoomMemberRolesAndPermissions
|
|
summary: Get room member roles and permissions
|
|
description: >
|
|
Retrieves the roles and associated permissions that a user can have as a member of a specified OpenVidu Meet room.
|
|
tags:
|
|
- Internal API - Rooms
|
|
parameters:
|
|
- $ref: '../../components/parameters/room-id-path.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-get-room-member-roles.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/error-room-not-found.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
/rooms/{roomId}/roles/{secret}:
|
|
get:
|
|
operationId: getRoomRoleAndPermissions
|
|
summary: Get room role and permissions
|
|
description: |
|
|
Retrieves the role and associated permissions that a user will have as a member of a specified OpenVidu Meet room
|
|
when using the URL that contains the given secret value.
|
|
|
|
This endpoint is useful for checking the user's role and permissions before accessing the room.
|
|
tags:
|
|
- Internal API - Rooms
|
|
parameters:
|
|
- $ref: '../../components/parameters/room-id-path.yaml'
|
|
- $ref: '../../components/parameters/internal/secret.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-get-room-member-role.yaml'
|
|
'400':
|
|
$ref: '../../components/responses/internal/error-invalid-room-secret.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/error-room-not-found.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|