This section explains how Apps can be created, edited and deleted easily in cidaas administrator dashboard.
Before we go in detail into configurations, let us ask what app types suit my business channel?
Which App Type should I choose?
The choice of grant type should depend on your specific use case, the trustworthiness of the client app, and user experience you want for your users. Hence this selection needs careful consideration. Some grant types are more secure than others.
Refer to the diagram shown below, and identify which OAuth 2.0 grant type flow you need to implement.
How do I create an App?
To create Apps, navigate to cidaas Administrator dashboard -> Apps -> “App Settings” on left navigation menu.
All created apps are displayed here by default. cidaas provides a filter / option to select the app types (Single Page Application, Regular Web Application).
Procedure to create App
1. Navigate to Apps -> App Settings.
2. Click Create New App.
This is where all the basic information about your application such as app name, app type, redirect URLs, allowed logout URLs, website, logo, company details, and more need to be entered.
4. Enter App name, for example: Books - Angular, jQuery, React-JS (your business name).
5. Enter App logo URL, for example:This logo will appear in several areas, including the list of applications in the Dashboard, as well as things like customized consent forms.
6. Administrator can change the App type from Android Mobile App, to any other app type (IOS Mobile App, Windows Mobile App, Single Page WebApp and Device).
8. Click the hyperlink to Import scopes from scope groups, as in the below screen, for more information click Scope Groups.
9. Select hosted page group from the dropdown. By default, cidaas provides these Hosted Pages.
10. Enter the redirect URL: The URL of the landing page. Once the user is successfully authenticated, they are redirected to this URL. User can specify multiple valid URLs here, separated by whitespace (typically to handle different environments such as QA or testing).
11. Enter the Allowed Logout URL to which the user will be redirected once they log out from the app.
This section helps provide the inputs relating to the company for which the app is being configured.
12. Company Name: Enter the company name which is displayed on the app.
13. Company Address: Enter the company address that is to be displayed while using this app.
14. Website URL: Provide the business site URL.
15. Terms and Conditions URL: This link will be rendered automatically on the login/registration pages if the Terms URL is configured.
In addition to above, cidaas allows you to configure few options for OAuth, Token payloads, social login providers.
These settings should be configured to define OAuth response types and origins
1. Click Advanced Settings to view the following screen.
2. From the dropdown, select response types checkbox (multiple checkboxes can be selected)
3. From the dropdown, select grant types checkbox (multiple checkboxes can be selected)
4. Enter allowed origins and allowed web origins.
5. From the dropdown, select Additional Access Token Fields checkbox (multiple checkboxes can be selected)
You can upload or define your consent policy, that you would like to show to your end user. There may be multiple policies that you want to show based on context.
Cidaas provided you a Consent Management framework that allows for this, including feature to maintain multiple versions of same policy.
By default, cidaas has a standard template that is displayed to your end users.
6 . From the dropdown, select created consent group, as in the below screen
You can manage security settings such as allowed providers, required fields and 2FA settings here.
7. From the dropdown, select allowed providers checkbox (multiple checkboxes can be selected)
8. Registration Fields: From the dropdown, select the allowed and required fields(multiple checkboxes can be selected). The values for these fields will be fetched from the enabled registration fields.
9. During registration, the new user should perform SMS or Email verification to validate their identity based on the configuration done by the admin for the app.
10. The administrator can enable the CAPTCHA and password policy at the app level.
11. Always ask for 2FA: When this option is enabled at the app level, the end-users need to verify their identity using the second authentication.
12 . Click the Save button.
Find the below advanced settings table for reference:
Response Type: The response type specifies the Response Type you want to use. This can be either code or token or ID token.
The client constructs the request URI by adding the following parameters to the query component of the authorization endpoint URI:
cidaas provides the following default Response Types, while creating the App:
Code: The Authorization Code grant type is used by confidential and public clients to exchange an authorization code for an access token. After the user returns to the client via the redirect URL, the application will get the authorization code from the URL and use it to request an access token.
Token: When the response type is specified as "token", the access token is directly issued.
Id_token: Id Token is issued only when the App has OpenID scope. The id_token issued is in the format of JWT token (JSON Web Token) - which is a compact, URL-safe means of representing claims to be transferred between two parties. The claims in a JWT are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message. .
Grant Type is the mechanism in which an application can get access token. Cidaas supports several Grant Types of OAuth 2.0 protocol. These are available for use while creating different type of apps (Andriod / iOS / Windows mobile / Web / Client / Device).
cidaas provides the following default Grant Types, while creating the App: Implicit/ Authorization Code/ Password/ Refresh Token.
Authorization Code: When you use this option, the application gets back an authorization code from resource owner, which in turn is used by application to get an Access Token from cidaas authorization server. Typical use cases are for browser based applications, mobile applications and apps on a web server.
Password: You can use this grant type if your application wants to use a classical login style, where end user has registered a username and password with cidaas. Login page will be cidaas app login screen. The password is used directly as an authorization grant to obtain an access token.
Refresh Token: Refresh tokens are credentials used to obtain access tokens. Refresh tokens are issued to the client by the authorization server and are used to obtain a new access token when the current access token becomes invalid or expires, or to obtain additional access tokens with identical or narrower scope.
Client Credentials: It is used as a grant type when an application wants to access its own resources (like icons, user statistics or web url) and not particular resource of a user.
Device Flow: The Device Flow is an OAuth 2.0 extension that enables devices with no browser or limited input capability to obtain an access token.
|Allowed Web Origins||Use this when you want to embed cidaas login in your web app using iframe. You can enter all the various URLs from where a cidaas login page is shown in an iframe. User can specify multiple valid URLs here, separated by whitespace. By default all domains mentioned in “Redirect URLs” (attribute entered in App settings) is allowed.|
|Additional Access Token Fields||Admin user can specify the additional fields (defined in the Registration setup) that will be appended to the access token. For more information refer Access Token Payload|
|Allowed Providers||Having popular social providers such as Facebook or Google, makes it convenient for end users to use their existing social accounts during login/registration. For more information refer Social Providers|
|Required Fields||The fields defined in the Registration Setup are listed, and the Admin can select the fields that need to be made mandatory at the app level. For more information refer Registration Setup|
13. Select appropriate roles from the dropdown.
14. Select appropriate cidaas Administrator role from the dropdown.
15. Select appropriate groups from the dropdown, as in the below screen,
16. Click Save. A success message window pop ups.
The JWE (JSON Web Encryption) specification standardizes the way to represent an encrypted content in a JSON-based data structure.
17. Enable JWE and click Save button.
Json Web Tokens (JWT) are used to secure the information exchange between the users and the application. To provide more security to the access token the public and private key are defined.
Using a RSA asymmetric key pair, the JWT is signed with the private key and verified with the public key.
Public Key: Which is in the form of encrypted.
Private Key: Which decode the encrypted token.
18 . Once the appropriate App is created, the certificates (Public and Private keys) gets displayed as in the below screen.
App Custom Fields
User can define the custom fields (multiple fields can be defined).
Flow Setting (Beta)
Administrators can configure the business flows at app level using the flow settings.It contains the following flow criteria:
Allow Login With: Administrators can specify the values with which a user can be allowed to login in this field (For e.g., username, mobile, email)
Register with Login Information: When the "Register with Login information" option is enabled, the user gets automatically registered when he opts for Social Login (Using Social providers such as Facebook/ Google etc.) on the Login page. If this option is disabled, when the user tries to login to the application for the first time before registration using Social login, an error message will be displayed. The user will have to then use social login on the registration page or register himself using classical registration.
FDS Enabled:: When Administrators enable this option, cidaas FDS detects if the user who tries to login is a legitimate user, based on pre-defined criteria.
Enable Passwordless Auth: Administrators can enable Passwordless authentication at App level
Enable Deduplication: Administrators can enable deduplication at App level. This option ensures that redundant users accounts are not created.
Allow Disposable Email: Administrators can allow user registration using disposable email (i.e. email IDs created by online fake email generators such as firstname.lastname@example.org)
Validate Phone Number: When Administrators enable this option, the user’s phone number is verified at the time of registration.
19 . Click the Save button which will display a message window.
20 . Once all the mandatory fields are filled, user get the Client ID and Client Secret, as in the below screen
21 . To reveal client secret id, click the view icon .
22 . To reset client secret id, click the reset icon , which provides a different client secret id.
23 . The created app gets displayed in “Your Apps”
24 . Cancel button redirects to app types screen.
25 . click the chart icon button that will shows the app usage chart it displays total number of login and registration, failure user’s counts for the particular date and time.