[OPENIDM-5630] Document Self-Service Stage creation Created: 18/Apr/16  Updated: 01/Jun/17  Resolved: 30/May/17

Status: Closed
Project: OpenIDM
Component/s: documentation
Affects Version/s: OpenIDM 4.0.0
Fix Version/s: None

Type: Improvement Priority: Major
Reporter: Tim Sedlack [X] (Inactive) Assignee: Mike Jang
Resolution: Expired Votes: 1
Labels: CDM, CLARK, Doc, SelfRegistration, Social
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File TOS.1.png     PNG File TOS.2.png    
Issue Links:
is related to OPENIDM-8437 Self-Service UI, Privacy/Consent, Doc... Closed
Target Version/s:
Story Points: 2


Document how to create custom stages for Self-Service along with threads in community where the question has arisen and been answered.

From Community----
Sample https://stash.forgerock.org/projects/COMMONS/repos/forgerock-selfservice/browse/forgerock-selfservice-custom-stage/src/main/java/org/forgerock/selfservice/custom

(moved here: https://stash.forgerock.org/projects/COMMONS/repos/forgerock-commons/browse/self-service/forgerock-selfservice-custom-stage/src/main/java/org/forgerock/selfservice/custom )

Example configuration where above is used https://stash.forgerock.org/projects/COMMONS/repos/forgerock-selfservice/browse/forgerock-selfservice-example/src/main/resources/registration.json

(moved here: https://stash.forgerock.org/projects/COMMONS/repos/forgerock-commons/browse/self-service/forgerock-selfservice-example/src/main/resources/registration.json)

{ "class" : "org.forgerock.selfservice.custom.MathProblemStageConfig", "leftValue" : 12, "rightValue" : 4 }


Comment by Mike Jang [ 22/Jul/16 ]


 Enduser is on Self-Reg page,

  • if social providers are enabled, they can select one to bring over data to fill in the self-reg form.  
    • Otherwise, they fill the form in and click Create New Account button.  
    • They are presented with Terms of Service window and can either Accept, in which case new user is created, or Return to Login Page, in which case no user is created.

(TBD: when ToS appear)

Comment by Mike Jang [ 22/Jul/16 ]

from Brendan: I am trying to draw your eyes to the present discussion that ToS/TaC can be implemented two different ways – one with a separate full-page stage that Jason and I just finished; one with a checkbox inline with the registration page as Colin is demonstrating.

see TOS.1.png, TOS.2.png

Comment by Mike Jang [ 11/Oct/16 ]

Nicolas Philippe [X] I see this on your list, as a priority for the current sprint. Can you give me a use case? What additional stage would our customers want to add, say to the CDM registration process?

Comment by Kavya Muthanna [X] (Inactive) [ 19/Oct/16 ]

@Mike Check this recent blog post from Andrew Potter on the topic of creating custom stage - http://yaunap.blogspot.com/2016/07/custom-stages-to-user-self-service_1.html. It would be a good exercise to make this part of the documentation.

Comment by Mike Jang [ 03/Apr/17 ]

Moving out of GB 5.5 due to priorities. May restore later.

Comment by Mike Jang [ 25/Apr/17 ]

Chris Drake Do you think this is important – is this a common use case?

Comment by Chris Drake [ 25/Apr/17 ]

Not sure if it's common, however it's one we've seen a few times. There are definitely customers having created and wanting to create their own custom stages.

Comment by venu alla [ 05/May/17 ]

My request is to make this just as intuitive and flexible as OpenAM's AuthnModule and AuthnChain feature. So that deployers can create Custom Reg Stages, and create a RegChain which is a combination of OOTB Reg Stages and Custom Reg Stages. Allow deployers to create multiple RegChains (just like multiple Authn Chains in OpenAM). Allow deployers access RegChains via request param such as "service=regChain1" (similar to OpenAM's service=authChain1). This will be very helpful to address customer's needs for a flexible and extensible Registration Service. Currently it is not.

Comment by Mike Jang [ 05/May/17 ]

venu alla Thanks for your comments. I know we're starting some serious self-service changes based on GDPR – which IMO may lead to changes in this process for >=5.5

However, getting to a point where we can support custom registration stages "as flexible as OpenAM's AuthnModule and AuthnChain" features, I'm guessing would require serious additional work. I suggest that you raise the issue with Kavya Muthanna [X]

Generated at Thu Jul 19 23:59:24 BST 2018 using JIRA 7.3.8#73019-sha1:94e8771b8094eef96c119ec22b8e8868d286fa88.