WSO2 API Manager- Customizing Store User Sign-Up

WSO2 API Manager allows on boarding new users to the API store through a Sign-up page. The default sign-up page has set of mandatory and optional fields for user to provide details. However, there can be cases where one needs to customize the available fields by modifying available ones or/and adding new fields.

This can be easily achieved in WSO2 API manager since the fields are loaded dynamically from the user claim attributes. So this post explains how we can customize the default Sign-up page.

By default API Store Sign-up looks as below. Note that this blog posts shows how to do this in APIM 2.1.0.



Let's say you want to add a new field called 'City' to Store Sign-up page. This post provides step by step instructions on how to achieve this.

1. Start API Manager 2.1.0 and go to Management Console (https://localhost:9443/carbon/)

2. Go to Claims -> Add -> Add Local Claim



3. Enter the below values for the new claim.


Claim URI : http://wso2.org/claims/city
Display Name : City
Description : City
Mapped Attribute : city
Supported by Default : select

Note that claims which are 'Supported by Default' true, are only displayed in the Sign-up page. Therefore when you are adding new claims make sure to check 'Supported by Default' checkbox.



If you need this claim to be a required field [Mandatory field in Sign-up], make sure to check 'Required' checkbox.

After entering the values, click 'Add'.

7. Now go to API Store Sign-up page and refresh. You should see the newly added field.



Modifying Existing Claims

Let's say now you want to make the city field 'required'. Also you want to change the field display order. 

1. For that go to Claims -> List and click on http://wso2.org/claims. In the displaying list of claims click Edit on "City" claim.

Listing Claims

Edit Claim

Now select Required checkbox. Also I have changed the display order of all the city claim to 4. 


Check Required and change display order



2. Now Access the API Store Sign-up page. You will see that the "City" field is re-ordered and marked as required.






Comments

  1. AsaJuly 25, 2017 at 12:48 AM

    great post.
    little bit Explanation is much useful to learn bit fast.
    nice job!

    ReplyDelete
  2. UnknownMarch 2, 2018 at 8:03 PM

    Can we create user(custom user other than admin) for read only and api approval in api store.

    ReplyDelete
  3. Tech StudioJanuary 18, 2020 at 1:31 AM

    Aiman Online Quran Learning Academy is an impressive online academy for teaching the Quran.
    This leading online Quran academy from
    Pakistan provides you an excellent chance to have one
    online Quran classes for kids with tajweed and learn
    the basic teachings of Islam.

    ReplyDelete
  4. Tech StudioMarch 7, 2020 at 4:08 AM

    latest govt job in india

    ReplyDelete

Post a Comment

Popular posts from this blog

PHP-SOAP web service with out a WSDL

This article is going to describe how to create a simple web service with php-soap step by step. Requirements     Server to run php (apache, xampp , wamp)     PHP-SOAP extension Steps Let's write a simple web service to find the length of a given string. So here is the code for StringLengthServer.php   <?php # StringLengthServer.php # Copyright (c) 2011 by Lakmali Baminiwatta #     function findLength($string) {            return "Length of the string " . $string . "is : ".strlen($string);     }            $server = new SoapServer(null,               array('uri' => "urn://www.lakmali.lk"));        $server->addFunction("findLength");        $server->handle();  ?> First thing done here is to writ...
Keep reading

Boomi Mapping - Removing special chars from an input

Image
Dell Boomi mapping shape provides numerous ways to modify/enrich an input via functions. In this post I am going to show how I validated and removed special chars from an input using Scripting and do it along with another string function. The user defined functions available with mapping, allows us to apply sequence of functions to the input. In this example, I am going to use it. Use Case: I have two input strings coming from the source profile (first_name and last_name), which I want to first concatanate together and then remove non-alphanumeric characters if present. Solution In your map, add an User Defined function and add two inputs; first_name, last_name.  Add User Defined function into the map Added inputs to the user defined function As the first step, add a function "String Concat" under the  "String" category.  Specify first_name and last_name as the inputs. Also set a delimiter, if you need a one. In my case, I want to concatena...
Keep reading

Boomi Mapping - User Defined function based on list of elements in a collection

Image
Recently I came across a requirement to validate all the elements in a collection and return an output based on that. Let me explain it with an example. I have a XML document containing information about users including a collection to indicate the roles of the person. Source Document <users> <user> <first_name></first_name> <roles> <role> admin </role> <role> subscriber </role> <role> creator </role> </roles> </user> </users> Destination Document I want to map this into a destination profile which has elements to indicate whther the user is an admin or a subsriber. <users> <user> <isAdmin> true </isAdmin> <isSubscriber> true </isSubscriber> <user> <users> </users> In order to achieve this I have to write a map funtion. But for a map funtion, we can't input a collection. If we map the "roles" collect...
Keep reading