Custom providers

cidaas allows administrator to configure additional identity providers than what is offered by it, by default. This identity provider can be your favorite/business email ID provider.

This option Custom Providers, within Admin settings allows an Administrator to set up your customized provider, and use that for user registration and login.

Navigate to Admin Dashboard -> Settings -> Login Provider.

1. Click on Custom Oauth2 & OpenId Connect option.

2. Click on Add new Provider button to add new custom provider.

3. Now you can enter the required information about the Custom provider.

Details of your provider includes :


Provider Name: Name of the provider you want to add.
Display Name: Name of the provider that you would like to display. Logo URL: Logo to be displayed.


Authorization URL: The URL of provider, which authorizes the user.

Standard Type: The standard type contains two OAUTH2 and OPENID_CONNECT

Note: If the administrator select OAUTH2 standard, we can change the keys of userinfo fields. If the administrator selects OPENID_CONNECT standard we cannot change the field keys because the OPENID_CONNECT follows standard fields.

Token Endpoint:

Token Endpoint: The URL used to get the access_token with oauth2 format.


Scope: The scope parameters for which you want access rights.

We can add multiple scopes and define if they are mandatory or as recommended

User Information:

UserInfo URL: The URL used to get user info.

User Info Fields Description

sub {string}

The subject (end-user) identifier. This member is always present in a claims set.

name {string}

Full name of the end-user, with optional language tag.

[ given_name ] {string}

Given or first name of the end-user, with optional language tag.

[ family_name ] {string}

Surname(s) or last name(s) of the end-user, with optional language tag.

[ middle_name ] {string}

Middle name of the end-user, with optional language tag.

[ nickname ] {string}

Casual name of the end-user, with optional language tag.

[ preferred_username ] {string}

Username by which the end-user wants to be referred to at the client application.

[ profile ] {string}

URL of the profile page for the end-user, with optional language tag.

[ picture ] {string}

URL of the profile picture for the end-user.

[ website ] {string}

URL of the end-user’s web page or blog.

[ email ] {string}

End-user’s preferred email address.

[ gender ] {"male"|"female"|?}

End-user’s gender.

[ birthdate ] {string}

End-user’s birthday, represented in ISO 8601:2004 YYYY-MM-DD format. Year may be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed.

[ zoneinfo ] {string}

End-user’s time zone, e.g. Europe/Paris or America/Los_Angeles.

[ locale ] {string}

End-user’s locale, represented as a BCP47 language tag. This is typically an ISO 639-1 Alpha-2 language code in lowercase and an ISO 3166-1 Alpha-2 country code in uppercase, separated by a dash. For example, en-US or fr-CA.

[ mobile_number ] {string}

End-user’s preferred mobile number, typically in E.164 format, for example +91 9543435147

[ updated_at ] {number}

Time when end-user information was last updated, in number of seconds since the Unix epoch (1970-01-01T0:0:0Z) as measured in UTC until the date/time.

4. Created custom provider info can be edited by clicking on the edit icon corresponding to provider name.

Another way to map custom provider to your app:

Navigate to Apps -> App Settings -> Edit Apps -> Advance settings -> Login providers.

Here also we can map your custom provider to your app.

Set up the Connection in cidaas

1. Go to cidaas Admin dashboard -> Settings -> Login Provider ->Custom Oauth2 & OpenID Connect, then select the Sample Provider app from the menu and paste the copied Client ID and Client Secret to respective text fields.

2. We can use custom provider in user/admin portal (Login and Register) pages.

3. Click on Save Button.

4. Now mapping configured Custom provider to the particular application using the dropdown box.

Note: Administrator can configure single provider to more than one client.

5. After mapping all the required clients, click on Save button.

This successfully enables custom provider on your portal, and will be visible next to other social provider options availalbe during login.

Having popular social providers such as Facebook or Google, and also custom provider makes it convenient for end users to use their existing provider during login/registration. For more information refer Social Providers

results matching ""

    No results matching ""