Changes for page Community App Developer Guide

Last modified by bougault on 2022/03/02 11:58

From 2.3 to 2.2 From 9.1 to 8.2

From version 8.2

edited by allan
on 2019/11/25 14:29

Change comment: Update document after refactoring.

To version 2.3

edited by allan
on 2019/09/19 11:16

Change comment: Creating the client

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Objects (0 modified, 0 added, 2 removed)
- XWiki.DocumentSheetBinding[0]
- XWiki.DocumentSheetBinding[1]

Details

Page properties

Parent

@@ -1,1 +1,1 @@
--Collabs.collaboratory-community-apps.WebHome
++Collabs.collab-devs.RFC.WebHome

Content

@@ -1,23 +1,25 @@
--Developers can extend the Collaboratory capabilities by providing applications to its community of users.
++The Collaboratory is designed to be extended with applications provided by its community of users.
--This guide describes the steps to make this possible.
++This guide describes how developers can contribute by creating and registering applications within the Collaboratory.
++{{toc numbered="true" start="2"/}}
++
  == Becoming a contributor ==
--The first step is for you to **become a contributor**. Contributors can register and manage applications within the Community Apps Catalogue.
++The first step is for you to be recognised as a contributor. Contributors can register and manage applications within the Community Apps Catalogue.
--Send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions.
++To become a contributor, send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions.
--The support team will apply the permissions to your user: your account will be upgraded with developers privileges the next time you will login.
++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.
  (% class="box infomessage" %)
  (((
--Only SGA2 accredited users will be automatically granted the contributor level.
++Please note that, currently, only SGA2 accredited users will be automatically granted the contributor level.
  )))
  == Registering an application in the Catalogue ==
--Collab authors find applications to add to their collabs in the Community Apps Catalogue.
++The Community Apps Catalogue is the place where collab authors look for applications to add to their collabs.
  {{error}}
  TODO: describe the steps to register an app in the Catalogue
@@ -27,15 +27,15 @@
  The steps to create an OpenID Connect client are the following:
--1. get an access token from the `developer` client
--1. use the token to call the create endpoint
--1. save your registration access token for further modifications of your client
++* get an access token from the `developer` client
++* use the token to call the create endpoint
++* save your registration access token for further modifications of your client
  === Fetching your developer access token ===
--Getting your developer token is done in one simple step: authenticate against the developer client with the password grant.
++In order to get your developer token, you need to authenticate against the developer client with the password grant.
--This can be achieved with this sample shell script:
++This can be achieved with this sample bash script:
  {{code language="bash"}}
  # Gather username and password from user
@@ -71,11 +71,11 @@
  }
  {{/code}}
--Copy the "access_token" value, you will need if for the next step.
++Copy the "access_token" value, it is the one that will be needed for the next step.
  === Creating the client ===
--You can now create clients by sending a JSON representation to a specific endpoint:
++Clients can be created by sending a JSON representation to a specific endpoint:
  {{code language="bash"}}
  # Set your developer token
@@ -158,36 +158,5 @@
  Among all the attributes, you should securely save:
--* your client **secret** ("secret" attribute): it is needed by your application to **authenticate to the IAM server** when making backend calls
--* your client **registration access token** ("registrationAccessToken"): you will need it to authenticate when **modifying your client in the future**
--
--=== Modifying your client ===
--
--Update your client with a PUT request:
--
--{{code language="bash"}}
--# Set your registration token and client id
--clb_reg_token=...
--
--# Update the client
--curl -X PUT https://iam.humanbrainproject.eu/auth/realms/hbp/clients-registrations/default/my-awesome-client \
--  -H "Authorization: Bearer ${clb_reg_token}" \
--  -H 'Content-Type: application/json' \
--  -d '{
--        "clientId": "my-awesome-client",
--        "redirectUris": [
--            "/relative/redirect/path",
--            "/these/can/use/wildcards/*",
--            "/a/new/redirect/uri"
--        ]
--    }' |
--
--# Prettify the JSON response
--json_pp;
--{{/code}}
--
-- Note that your need to provide your client id both in the endpoint URL and within the body of the request.
--
--{{warning}}
--/!\ **  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.   **/!\
--{{/warning}}
++* your client secret ("secret" attribute) which is needed by your application to authenticate to the IAM server when making backend calls
++* your client registration access token ("registrationAccessToken")  which is the token you will need to authenticate when modifying your client in the future