Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

Commit 32bbca3

Browse files
committed
Updated some API documentations regarding the deprecation of passwords
1 parent 2689a1e commit 32bbca3

File tree

3 files changed

+27
-3
lines changed

3 files changed

+27
-3
lines changed

_data/create.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,10 @@
99
description: "A meeting ID that can be used to identify this meeting by the 3rd-party application. <br><br> This must be unique to the server that you are calling: different active meetings can not have the same meeting ID. <br><br> If you supply a non-unique meeting ID (a meeting is already in progress with the same meeting ID), then if the other parameters in the create call are identical, the create call will succeed (but will receive a warning message in the response). The create call is idempotent: calling multiple times does not have any side effect. This enables a 3rd-party applications to avoid checking if the meeting is running and always call create before joining each user.<br><br> Meeting IDs should only contain upper/lower ASCII letters, numbers, dashes, or underscores. A good choice for the meeting ID is to generate a <a href=\"http://en.wikipedia.org/wiki/Globally_unique_identifier\">GUID</a> value as this all but guarantees that different meetings will not have the same meetingID."
1010

1111
- name: "attendeePW"
12-
required: "(recommended)"
1312
type: "String"
1413
description: "The password that the <a href=\"#join\">join</a> URL can later provide as its <code class=\"language-plaintext highlighter-rouge\">password</code> parameter to indicate the user will join as a viewer. If no <code class=\"language-plaintext highlighter-rouge\">attendeePW</code> is provided, the <code class=\"language-plaintext highlighter-rouge\">create</code> call will return a randomly generated <code class=\"language-plaintext highlighter-rouge\">attendeePW</code> password for the meeting."
1514

1615
- name: "moderatorPW"
17-
required: "(recommended)"
1816
type: "String"
1917
description: "The password that will <a href=\"#join\">join</a> URL can later provide as its <code class=\"language-plaintext highlighter-rouge\">password</code> parameter to indicate the user will as a moderator. if no <code class=\"language-plaintext highlighter-rouge\">moderatorPW</code> is provided, <code class=\"language-plaintext highlighter-rouge\">create</code> will return a randomly generated <code class=\"language-plaintext highlighter-rouge\">moderatorPW</code> password for the meeting."
2018

_data/join.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- name: "password"
1212
required: true
1313
type: "String"
14-
description: "This password value is used to determine the role of the user based on whether it matches the moderator or attendee password. Note: This parameter is *not* required when the role parameter is passed."
14+
description: "This password value is used to determine the role of the user based on whether it matches the moderator or attendee password. Note: This parameter is <b>not</b> required when the role parameter is passed."
1515

1616
- name: "role"
1717
required: true

_posts/2.4/2021-06-09-new.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ Blurring the background
163163
<img src="/images/24-background-blur-3.png" alt="Background blur for webcam" />
164164
<br /><br />
165165

166+
###
167+
166168
## Engagement
167169

168170
### Improved Layout Manager
@@ -381,3 +383,27 @@ The best ways to contribute at the current time are:
381383
- Try out installing BigBlueButton 2.4 and see if you spot any issues
382384
- Help test a [2.4 pull request](https://github.com/bigbluebutton/bigbluebutton/pulls?q=is%3Aopen+is%3Apr+milestone%3A%22Release+2.4%22) in your development environment
383385
<!-- TODO create a GitHub label for contributions-welcome and link here -->
386+
387+
## API
388+
389+
### Deprecation of password
390+
391+
Even though it is still possible to create a meeting with a password, it is now being deprecated, and it is not required anymore. So here are some explanations to better ilustrate this update:
392+
393+
- **Create** - It is possible and recommended to not use the passwords while creating the request:
394+
395+
```url
396+
https://bbb25.bbbvm.imdt.com.br/bigbluebutton/api/create?allowStartStopRecording=true&attendeePW=ap&moderatorPW=mp&... &checksum=
397+
```
398+
or
399+
```url
400+
https://bbb25.bbbvm.imdt.com.br/bigbluebutton/api/create?allowStartStopRecording=true&... &checksum=
401+
```
402+
403+
- **Join** - These requests don't need to follow the `/create` endpoint, on the grounds that it has its own parameter to know the role of the user. Se the explanation down below:
404+
405+
- In any cases, if the `role` parameter is sent along, it will be respected, even if `password` is passed too;
406+
- If the `role` parameter is not passed in the call, and the password exists (i.e., it has been sent in `/create` endpoint), then the password is mandatory for the `/join` endpoint to acknowledge which role does the user have.
407+
- If the password does not exist (i.e., it was not defined in `/create` endpoint), then the `role` parameter is mandatory, otherwise it is not possible to enter a meeting.
408+
409+
- **End** - the password is really not used here. But, if it was set (in the `/create` endpoint) and passed along in the `end` endpoint, it will be validated, otherwise, it won't.

0 commit comments

Comments
 (0)