[Fiware-creatifi-coaching] KeyRock API: documentation?

[Andrea Maestrini]

Dear FIWARE coach,
we forward you a support request received from a CreatiFI applicant we 
are not able to solve.
Please let us know if you need direct contact with the submitter.
Thanks.


  General Support #9: KeyRock API: documentation?
  <http://techsupport.creatifi.eu/issues/9>

  * Author: Daniele Fusi
  * Status: New
  * Priority: Normal
  * Assignee: Trento Tech Support (Italy&Belgium)
  * Category: Trento Hub (Italy)
  * Support Type: FIWARE Infrastructure

I'm trying to understand the capabilities of KeyRock GE to use it in a 
scenario where a client-side web app should allow both registration of 
new users and login.

The KeyRock documentation seems insufficient for my evaluation. I can 
easily create a new user using the FiWare web UI, yet the only 
documentation here points to a video with the procedure for doing this.

/(As a general remark, please do not underestimate the power of a 
well-written documentation for the adoption of your technology. As a 
developer, I prefer having even less numerous, but well-documented and 
fully refined components, rather than a bunch of stuff without further 
aid. First of all, it would be really useful to have more "real-world" 
documentation here. Videos are often just descriptions of procedures, or 
generic talks; developers also need raw programmers guides, where to 
find references and examples, possibly short and to the point. 
Personally I hate having to skip back and forth in a video hoping to 
happen at the right point in time and find what I need. Traditional 
documentation here is much more usable as I can easily scroll and locate 
what I need, and eventually copy it or save it somehow for later. Also, 
the existing documentation looks fragmented and scattered along several 
places, hosted in different sites or GitHub projects. It is often hard 
to f! ind and follow its path from one system to another, and remember 
which was the useful link.)/

The programmer's guide instead gives more insight in the GE, yet I 
cannot get to the real thing. For instance, take a registration process: 
it requires a complex flow, but first of all of course a way of adding a 
new user. Thus, I'd first need to know the data model for representing a 
registered user. Which data are stored for a user? E.g. name, email, 
etc. Are they closed or I can add custom fields? Or should I rather add 
them to another database with some user ID as a FK? Which attribute is 
used as a PK? Which are the attributes domains? E.g. max length for a 
field, or password strength policies constraints, etc.

Looking at https://github.com/ging/fi-ware-idm/blob/master/API.md it 
seems that to register a new user I should refer to the add new actor 
API: this requires an app slug, a user slug and a set of roles. Yet, how 
this is related to section #6 <http://techsupport.creatifi.eu/issues/6> 
of the same page, Users API? Which is the difference between an actor 
and a user? And at any rate, there seems to be no way of creating new users.

Looking further at 
https://github.com/ging/fi-ware-idm/wiki/Using-the-FI-LAB-instance where 
the returned user data contain a nickname, a display name, an email 
address, a numeric ID and an actor ID which looks like a FK, I get even 
more confused. The data are different, the entities are different, and 
have a connection via a FK. Which is for what?

------------------------------------------------------------------------

You have received this notification because you have either subscribed 
to it, or are involved in it.
To change your notification preferences, please click here: 
http://techsupport.creatifi.eu/my/account


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-creatifi-coaching/attachments/20141106/b7afbf93/attachment.html>