Version 20.1 by messines on 2021/04/26 11:49
Show last authors
1 == Abstract ==
2
3 In order to create an OIDC client, see [[1. Registering an OIDC client>>https://wiki.ebrains.eu/bin/view/Collabs/collaboratory-community-apps/Community%20App%20Developer%20Guide/1.%20Registering%20an%20OIDC%20client/]]. After creating the OIDC client, you have a corresponding access token and secret.
4
5 For the example below, we consider the case of someone wanting to provide access to https:~/~/www.getpostman.com as an app for Collaboratory users to access from their collabs. You should replace that URL by the one of your own app.
6
7 The redirect_uri is set with the URL of your application to which your users will be redirected after having been authenticated by their EBRAINS account. For example when you login to this wiki, the redirect URI is [[https:~~/~~/wiki.ebrains.eu/*>>https://wiki.ebrains.eu/*]]
8
9 [[image:Screenshot 2020-07-15 at 17.47.12.png||height="517" width="758"]]
10
11
12 The whole authentication flow presented here is based on the official OAuth2 RFC described in the section 4.1.
13
14 [[https:~~/~~/tools.ietf.org/html/rfc6749#section-4.1>>https://tools.ietf.org/html/rfc6749#section-4.1]]
15
16 [[image:Screenshot 2020-07-15 at 18.32.14.png||height="410" width="474"]]
17
18 == Authentication flow ==
19
20 === Authorization Code Request ===
21
22 The first step of the authentication protocol is to fetch an **authorization code **for your client and your user. This is done by directing your users to the URL of the EBRAINS login page (**IAM**) where they can enter their username and password.
23
24 ==== Request ====
25
26 The authorization **code **is fetched by an HTTP request:
27
28 /GET: [[https:~~/~~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth>>https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth]]
29
30 with the following parameters:
31
32 * response_type=code
33 * login=true
34 * client_id=**//community-apps-tutorial//**
35 * redirect_uri=**//https:~/~/www.getpostman.com/oauth2/callback//**
36 * scope=openid**//+group+team//**
37
38 with the italics indicating the fields you customize for your own app. The URL will look like:
39
40 https:~/~/iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/auth?response_type=code&login=true&client_id=//**community-apps-tutorial**//&redirect_uri=//**https:~/~/www.getpostman.com/oauth2/callback**//&scope=openid//**+group+team**//
41
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
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 * **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 * **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
54 {{info}}
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.
56 {{/info}}
57
58 ==== Response ====
59
60 Once the user has logged in, your app gets an HTTP 301 redirection followed by an HTTP 200 success response with an authorization **code** inside. A typical response might look like:
61
62 https:~/~/www.getpostman.com/oauth2/callback?session_state=a0ff8a68-2654-43ef-977a-6c15ce343546&code=**f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7**
63
64 (% class="box infomessage" %)
65 (((
66 The authorization **code** is the part in bold in the response above.
67 )))
68
69 === Access Token Request ===
70
71 (% class="wikigeneratedid" id="HRequest-1" %)
72 Now that your app has the **authorization** **code** for a user, it can fetch the user ID Token and Access Token
73
74 ==== Request ====
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]]
77
78 with the following parameters:
79
80 * grant_type: authorization_code
81 * code: **//f3f04f93-hbp-482d-ac3d-demo.turtorial.7122c1d9-3f7e-4d80-9c4f-dcd244bc2ec7//**
82 * redirect_uri: **//[[https:~~/~~/www.getpostman.com/oauth2/callback>>https://www.getpostman.com/oauth2/callback]]//**
83 * client_id: **//community-apps-tutorial//**
84 * client_secret: **//your client secret obtained during client creation//**
85
86 The image below shows a sample POST request generated from the Postman tool. [The fact that this page is based on getpostman.com as an example is pure coincidence.]
87
88 [[image:Screenshot 2020-07-15 at 18.20.34.png]]
89
90
91 ==== Response ====
92
93 200 OK
94
95 (% class="box" %)
96 (((
97 {
98 "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAi...pP5vaNwvvsaNGEA",
99 "expires_in": 604773,
100 "refresh_expires_in": 604773,
101 "refresh_token": "eyJh...vC5eIR1rNhRJ4d8",
102 "token_type": "bearer",
103 "id_token": "eyJ...YOwdQ",
104 "not-before-policy": 0,
105 "session_state": "76e553bf-ba2e-45b6-8c6c-c867772b40ec",
106 "scope": "openid"
107 }
108 )))
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.
111
112 == Access user info ==
113
114 Now that your app has the access token of a user, it can fetch the user's info.
115
116 ==== Request ====
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]]
119
120 with the following parameters:
121
122 * Authorization: the access token preceded by the string "Bearer "
123
124 The image below shows a sample GET request generated from the Postman tool. [The fact that this page is based on getpostman.com as an example is pure coincidence.]
125
126 [[image:Screenshot 2020-07-15 at 18.28.28.png||height="161" width="566"]]
127
128 ==== Response ====
129
130 As response your app receives a JSON with all the information about the logged user
131
132 (% class="box" %)
133 (((
134 {
135 "sub": "fa2db206-3...0ebaba98e1",
136 "unit": [
137 "/all/institutions/switzerland/epfl",
138 "/all/projects/hbp/consortium/SGA2/SP05",
139 "/all/projects/hbp/consortium/SGA3/WP6/T6_11"
140 ],
141 "roles": {
142 "jupyterhub": [
143 "feature:authenticate"
144 ],
145 "xwiki": [
146 "feature:authenticate"
147 ],
148 "team": [
149 "**collab**-collaboratory-community-apps-**editor**"
150 ],
151 "group": [
152 "**group**-collaboratory-developers",
153 "**unit**-all-projects-hbp-consortium-sga2-sp05-**administrator**"
154 ]
155 },
156 "mitreid-sub": "30...62"
157 }
158 )))
159
160 The unit field above lists Collaboratory Units which the user is a member of, with the unit name using slashes instead of the colons you see in the Collaboratory UI.
161
162 jupyterhub and xwiki are OIDC clients with more advanced permission management.
163
164 The team field above lists Collaboratory Teams which the user is a member of, in the form "collab-//collabname//-//role//" where //role //is one of admin, editor, or viewer according to the user's role in collab //collabname//.
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.