Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,25 +1,25 @@
1		-The Collaboratory is designed to be extended with applications provided by its community of users.
	1	+Developers can extend the Collaboratory capabilities by providing applications to its community of users.
2	2
3		-This guide describes how developers can contribute by creating and registering applications within the Collaboratory.
	3	+This guide describes the steps to make this possible.
4	4
5	5	{{toc numbered="true" start="2"/}}
6	6
7	7	== Becoming a contributor ==
8	8
9		-The first step is for you to be **recognised as a contributor**. Contributors can register and manage applications within the Community Apps Catalogue.
	9	+The first step is for you to **become a contributor**. Contributors can register and manage applications within the Community Apps Catalogue.
10	10
11		-To become a contributor, send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions.
	11	+Send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions.
12	12
13		-The support team will apply the permissions to your user and the next time you will login, your account will be upgraded with developers privileges.
	13	+The support team will apply the permissions to your user: your account will be upgraded with developers privileges the next time you will login.
14	14
15	15	(% class="box infomessage" %)
16	16	(((
17		-Please note that, currently, only SGA2 accredited users will be automatically granted the contributor level.
	17	+Only SGA2 accredited users will be automatically granted the contributor level.
18	18	)))
19	19
20	20	== Registering an application in the Catalogue ==
21	21
22		-The Community Apps Catalogue is the place where collab authors look for applications to add to their collabs.
	22	+Collab authors find applications to add to their collabs in the Community Apps Catalogue.
23	23
24	24	{{error}}
25	25	TODO: describe the steps to register an app in the Catalogue
...	...	@@ -35,7 +35,7 @@
35	35
36	36	=== Fetching your developer access token ===
37	37
38		-In order to get your developer token, you need to authenticate against the developer client with the password grant.
	38	+Getting your developer token is done in one simple step: authenticate against the developer client with the password grant.
39	39
40	40	This can be achieved with this sample shell script:
41	41
...	...	@@ -73,11 +73,11 @@
73	73	}
74	74	{{/code}}
75	75
76		-Copy the "access_token" value, it is the one that will be needed for the next step.
	76	+Copy the "access_token" value, you will need if for the next step.
77	77
78	78	=== Creating the client ===
79	79
80		-With your developer token, you can now create clients by sending a JSON representation to a specific endpoint:
	80	+You can now create clients by sending a JSON representation to a specific endpoint:
81	81
82	82	{{code language="bash"}}
83	83	# Set your developer token
...	...	@@ -160,5 +160,36 @@
160	160
161	161	Among all the attributes, you should securely save:
162	162
163		-* your client **secret** ("secret" attribute) which is needed by your application to **authenticate to the IAM server** when making backend calls
164		-* your client **registration access token** ("registrationAccessToken")  which is the token you will need to authenticate when **modifying your client in the future**
	163	+* your client **secret** ("secret" attribute): it is needed by your application to **authenticate to the IAM server** when making backend calls
	164	+* your client **registration access token** ("registrationAccessToken"): you will need it to authenticate when **modifying your client in the future**
	165	+
	166	+=== Modifying your client ===
	167	+
	168	+Update your client with a PUT request:
	169	+
	170	+{{code language="bash"}}
	171	+# Set your registration token and client id
	172	+clb_reg_token=...
	173	+
	174	+# Update the client
	175	+curl -X PUT https://iam.humanbrainproject.eu/auth/realms/hbp/clients-registrations/default/my-awesome-client \
	176	+ -H "Authorization: Bearer ${clb_reg_token}" \
	177	+ -H 'Content-Type: application/json' \
	178	+ -d '{
	179	+ "clientId": "my-awesome-client",
	180	+ "redirectUris": [
	181	+ "/relative/redirect/path",
	182	+ "/these/can/use/wildcards/*",
	183	+ "/a/new/redirect/uri"
	184	+ ]
	185	+ }' |
	186	+
	187	+# Prettify the JSON response
	188	+json_pp;
	189	+{{/code}}
	190	+
	191	+ Note that your need to provide your client id both in the endpoint URL and within the body of the request.
	192	+
	193	+{{warning}}
	194	+/!\ ** Each time you modify your client, a new registration access token will be generated. You need to track of your token changes to keep access to your client.   **/!\
	195	+{{/warning}}