Skip to main content

Enabling Self Registration in Identity Server 5.3.0

Self Registration is an important feature when in comes to commercial applications. This feature allows the users the priviledge of being a part of your community without you having to go through the hassle of adding them. Mentioning ihis Identity Server also allows the capability to restrict or revise the approvals before granting access but we will be discussing that in a seperate post.

This post will guide you on how you can enable the Self Registration feature using the self registration REST APIs at a global level for the WSO2 Identity Server 5.3.0.

You can try the Rest service through Identity Server login page (https://localhost:9443/dashboard)

There are two ways in which you can enable the feature.

1. Enable it at a global level across the whole platform.
2. Enable it per tenant basis.

Let's discuss how to enable it a global level across the whole platform..

Pre requisite 

  • Extracted WSO2 Identity Server 5.3.0. Let's name this as <WSO2_IS_HOME>

Enabling the Self Registration Feature at a global level with Recaptcha.
1. Navigate to <WSO2_IS_HOME>/repository/conf/identity/identity.xml file and comment out the below config block.

NOTE : PLEASE NOTE IF WE NEED TO ENABLE THIS AT A GLOBAL LEVEL IT NEEDS TO BE DONE BEFORE WE START UP  THE IDENTITY SERVER INSTANCE.

<SelfRegistration>
        <Enable>true</Enable>
        <LockOnCreation>true</LockOnCreation>
        <Notification>
            <InternallyManage>true</InternallyManage>
        </Notification>
        <ReCaptcha>true</ReCaptcha>
 </SelfRegistration>

Let's see what these configs mean.



2. Next we need to make sure some listeners are enabled in order for it to work when the operations are invoked.

In the same identity.xml file make sure the below configs are enabled/disabled. These are usually set by default in the product unless you have made any changes.
  • <EventListener ype="org.wso2.carbon.user.core.listener.UserOperationEventListener"name="org.wso2.carbon.identity.mgt.IdentityMgtEventListener" orderId="50" enable="false"/> 
  • <EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.identity.governance.listener.IdentityStoreEventListener" orderId="97" enable="true"> 
  • <EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.identity.scim.common.listener.SCIMUserOperationListener orderId="90" enable="true"/>
3. Configure email setting in <WSO2_IS_HOME>/repository/conf/output-event-adapters.xml file.

Hint: Search for the word 'email' in the file and you should be able to find the below block. Provide the email provider information and save it.


Now all the configurations needed for the self registration feature are done. Now we need to enable recaptcha.

4. Setup recaptcha as described in this documentation.

5. Now you can start up the identity server.

6. Once you start up navigate to the url https://localhost:9443/dashboard.

(This is for the default offset 0, if you have changed the offset please modify the port accordingly in the url).

In this dashboard which is shown above you will be able to see a link as Register Now. Click on that link and you will be directed to a screen as shown below.

You can provide the details and self register and enjoy this capability.

I hope this helped to understand how to enable the feature at a global level. In my next post I will be talking about how to customize the self signup registration page using claims.

References:

[1] https://docs.wso2.com/display/IS530/Configuring+reCaptcha+for+Self+Registration
[2] https://docs.wso2.com/display/IS530/Setting+Up+ReCaptcha
[3] https://docs.wso2.com/display/IS530/Self+Sign+Up+Using+REST+APIs
[4] https://docs.wso2.com/display/IS530/Self+Sign+Up+and+Account+Confirmation

Comments

Post a Comment

Popular posts from this blog

Processing large payloads with the esb script mediator iteratively

Overview WSO2 ESB uses Rhino engine to execute JavaScripts. Rhino engine converts the script to a method inside a Java class. Therefore, when processing large JSON data volumes, the code length must be less than 65536 characters, since the Script mediator converts the payload into a Java object. However, you can use the following alternative options to process large JSON data volumes. The script mediator which is used in ESB is powered by the Rhino engine. Therefore, when processing large JSON data volumes, the code length must be less than 65536 characters which is a limitation in the script mediator being used in the esb versions less than 5.0.0. In ESB 5.0.0 there is a higher capability to process larger payloads using script mediator. In order to process such large payloads we can follow the below two approaches. 1. Replace the javascript tranformation logic using java code by writing a custom mediator. [1] 2. Break down the large payload and execute them as sections using ...
Post a Comment
Read more

Invoking external endpoints using the call mediator in wso2 api manager

Introduction In API Manager if you need to do any service chaining use cases the call mediator comes in handy. If you need to use the response received by invoking one endpoint and then use it to invoke another endpoint you can use the call mediator in API Manager. The call mediator behaves in a synchronous manner. Hence, mediation pauses after the service invocation and resumes from the next mediator in the sequence when the response is received. You can read more about the call mediator in the wso2 esb documentation [1] . In api manager 1.10.0 the call mediator works in the blocking mode. Prerequisite Before we can use the call mediator in API Manager 1.10.0 we need to make the following changes to some configs. We need to comment the jms transport sender in axis2_blocking_client.xml found in the location APIM_HOME/repository/conf/axis2. This will resolve the jms sender initialization issues.   <!--transportSender name="jms"        ...
1 comment
Read more

Configure WSO2 Identity Server for single sign on with Moodle - Part I

Introduction Moodle is a learning platform designed to provide educators, administrators and learners with a single robust, secure and integrated system to create personalized learning environments.[1]. This is commonly used in the education sector and there might be occurrences where it would require to use SAML to login to Moodle instead of the default basic authentication. For this we would need to have an Identity Provider capable of issuing such SAML tokens and Moodle configured to accept the tokens in order to do the authentication I will be discussing this in two parts. Part I - How to configure moodle for SSO with WSO2 Identity Server Part II - How to carry our user provisioning and attribute profile mapping with Moodle and WSO2 Identity Server Let's see how this can be achieved using a SAML authentication plugin provided by one login. Prerequisite  You need to have a working version of Moodle installed. If you want to try this tutorial from scratch you can ...
1 comment
Read more