Skip to content

Commit 11cbd79

Browse files
authored
Add tools and OAuth documentation (#82)
1 parent 3adb632 commit 11cbd79

File tree

17 files changed

+378
-10
lines changed

17 files changed

+378
-10
lines changed

docs/services/bbb/Getting started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Add `FEATURE_VIDEOCONFERENCE_ENABLED=true` in **client** and **server** and
2121

2222
Add the right permission to the role. Permissions they need are `START_MEETING, JOIN_MEETING`.
2323

24-
Add "videoconference" to School features (table school) in MongoDB.
24+
Add "videoconference" to School features (table schools) in MongoDB.
2525

2626
Make sure that the fields below exists in the videoconference ltitool object (MongoDB).
2727

@@ -53,7 +53,7 @@ BBB has built in features to allow for such constellations. It has a waiting roo
5353
5454
These features are currently deactivated in dBildungscloud, but can be activated. In a POC we could confirm that it works as imagined, it just needs to be properly implemented now.
5555
56-
So for future developments we needs the following changes:
56+
The following changes are necessary:
5757
5858
**Client:**
5959
- Add an option on room creation, that allows external experts, but puts them in a waiting room
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "OAuth",
3+
"position": 8,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn about the OAuth strategy."
7+
}
8+
}

docs/services/oauth/concept.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# OAuth
2+
3+
## Login Process in SVS
4+
5+
![OAuth Flow](./img/oauth_flow.drawio.svg)
6+
7+
The following steps illustrated above:
8+
9+
1. The client initiates the flow by click on the "Login via XYZ" button and directing the user to the authorization endpoint.
10+
2. The identity provider authenticates the user and establishes whether the resource owner grants or denies the client's access request.
11+
3. Assuming the resource owner grants access, the identity provider redirects the user back to the SVS-Client using the redirect_uri provided in the authentication endpoint request earlier. The redirect includes an authorization code provided by the identity provider.
12+
4. The client then requests an access token with the given authentication code from the SVS-Server which
13+
5. The client requests the signing key from the identity provider to validate the token signature. The SVS-Server validates the signature of the ID tokens according to the specified algorithm.
14+
6. The provisioning for the specific external system is executed to either create or update user data.
15+
7. A JWT is generated for the user
16+
8. The JWT is stored in the client for later request against the SVS-Server-API
17+
18+
## Module Design
19+
20+
![OAuth Module Design](./img/Oauth_Module_Design.drawio.svg)

docs/services/oauth/img/Oauth_Module_Design.drawio.svg

Lines changed: 4 additions & 0 deletions
Loading

docs/services/oauth/img/oauth_flow.drawio.svg

Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "provining",
3-
"position": 8,
2+
"label": "provisioning",
3+
"position": 9,
44
"link": {
55
"type": "generated-index",
6-
"description": "Learn about the provining service."
6+
"description": "Learn about the provisioning service."
77
}
88
}

docs/services/provining/concept.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Concept provining
1+
# Concept Provisioning
22

33
## Login and provisioning flow
44

docs/services/schulcloud-client/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Schulcloud Client",
3-
"position": 9,
3+
"position": 10,
44
"link": {
55
"type": "generated-index",
66
"description": "Learn about the schulcloud-client repo."

docs/services/schulcloud-server/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Schulcloud Server",
3-
"position": 10,
3+
"position": 11,
44
"link": {
55
"type": "generated-index",
66
"description": "Learn about the schulcloud-server repo."

docs/services/tldraw-server/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Tldraw Server",
3-
"position": 11,
3+
"position": 12,
44
"link": {
55
"type": "generated-index",
66
"description": "Learn about the tldraw-server repo."

0 commit comments

Comments
 (0)