Changes for page 2. Authenticating with your OIDC client and fetch collab user info
Last modified by messines on 2021/06/08 17:32
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -42,14 +42,8 @@ 42 42 The **scope** parameter can include a combination of several values. Each user will be asked to consent to sharing that scope with your app upon first access. 43 43 44 44 * **openid: **This scope is required because we use the OIDC protocol. It will give your app access to the user's basic information such as username, email and full name. 45 -* **profile** (optional): More information on user if provided by the user 46 -* **email **(optional): The verified email of the user, should be add in addition of openid and/or profile to get the email. 47 47 * **group **(optional)**: **If you request this scope, the future access token generated will authorize your app to identify which units and groups the user belongs to. 48 48 * **team **(optional)**: **This scope is like the group scope lets your app identify the permissions of the user, but by identifying what collabs the user has access to and with what roles. 49 -* **clb.wiki.read **(optional): access to GET Collab API 50 -* **clb.wiki.write** (optional): access to DELETE/PUT/POST Collab API 51 -* **collab.drive **(optional): access to GET/POST/PUT/DELETE drive API 52 -* **offline_access **(optional)**: **provide refresh token 53 53 54 54 {{info}} 55 55 The group and team scopes are a simple way for your app to grant permissions to its services and resources when you want to grant access to a very few units, groups, or collab teams. For more complex permission management, contact support. ... ... @@ -69,11 +69,11 @@ 69 69 === Access Token Request === 70 70 71 71 (% class="wikigeneratedid" id="HRequest-1" %) 72 -Now that your app has the **authorization** **code** for a user, it can fetch the user ID Tokenand AccessToken66 +Now that your app has the **authorization** **code** for a user, it can fetch the user access token 73 73 74 74 ==== Request ==== 75 75 76 -/POST: [[https: ~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token]]70 +/POST: [[https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token>>url:https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token]] 77 77 78 78 with the following parameters: 79 79 ... ... @@ -107,7 +107,7 @@ 107 107 } 108 108 ))) 109 109 110 -Your app gets a response containing the **access token** ,the **refresh token,** the **id token **and other information.The ID Token should be use by developer on their backend to read user informations such as username, first name, last name etc. The ID Token should be use internally, into your app only, the app which triggered the authentication. The access token will be use to reach APIs, the access token can be see as a card to access an ATM. ID Token is for Authentication, Access token is for Authorization. Refresh token is to re-ask a valid access token after expiration.104 +Your app gets a response containing the **access token** and other information. 111 111 112 112 == Access user info == 113 113 ... ... @@ -115,7 +115,7 @@ 115 115 116 116 ==== Request ==== 117 117 118 -/GET: [[https: ~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo]]112 +/GET: [[https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo>>url:https:/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/userinfo]] 119 119 120 120 with the following parameters: 121 121 ... ... @@ -127,7 +127,7 @@ 127 127 128 128 ==== Response ==== 129 129 130 -As response your app receives a JSON with all the information aboutthe logged user124 +As response your app receives a JSON with all the information on the logged user 131 131 132 132 (% class="box" %) 133 133 ((( ... ... @@ -150,7 +150,7 @@ 150 150 ], 151 151 "group": [ 152 152 "**group**-collaboratory-developers", 153 - "**unit**-all-projects-hbp-consortium-sga2-sp05- **administrator**"147 + "**unit**-all-projects-hbp-consortium-sga2-sp05-administrator" 154 154 ] 155 155 }, 156 156 "mitreid-sub": "30...62" ... ... @@ -157,10 +157,12 @@ 157 157 } 158 158 ))) 159 159 160 -The u nitfield above lists CollaboratoryUnitswhichthe user isamemberof,with the unitslashes instead of the colons you see in the Collaboratory UI.154 +The group field above lists Collaboratory Groups in the form "group-//groupname//" and Collaboratory Units in the form "unit-//unitname//" with the unitname using dashes instead of the colons you see in the Collaboratory UI. 161 161 162 - jupyterhubandxwikiareOIDC clientswith more advancedpermissionmanagement.156 +The team field above lists Collaboratory Teams in the form "collab-//collabname//-//role//" where //role //is one of admin, editor, or viewer according to the user's role in collab //collabname//. 163 163 164 - Theteam field above lists Collaboratory Teams which theuser is a memberof, in the form "collab-//collabname//-//role//"where //role //is one of admin,editor, or vieweraccording to theuser'srole incollab //collabname//.158 +jupyterhub and xwiki are OIDC clients. 165 165 166 -The group field above lists Collaboratory Groups which the user is a member of, in the form "group-//groupname//". It also lists Collaboratory Units which the user is an admin of, in the form "unit-//unitname//-administrator" with //unitname //using dashes instead of the colons you see in the Collaboratory UI. 160 +The unit field above lists [useless noise?]. 161 + 162 +