Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 4 KB

SAMPLE_APPS.md

File metadata and controls

88 lines (58 loc) · 4 KB
Raw

Try Out the Sample Apps

Follow this guide to try out the sample app curated by Asgardeo. If you want to integrate Asgardeo for your own app, follow this guide.

Table of Content

Create an Application in Asgardeo

Before trying out the sample apps, you need to create an application in Asgardeo.

  1. Open the Asgardeo Console and go to the Applications > Develop tab.

  2. Click New Application and then Single Page Application.

  3. Enter any name you prefer as the name of the app.

  4. Add the redirect URL(s). For local environments, it will be something like https://localhost:3000. This will be used as a configuration in Running the sample apps section.Screenshot 2022-09-14 at 17 26 57

    Note The redirect URL usually is the URL in which your React application is hosted.

  5. Click Register. You will be navigated to the management page of the sample application.

  6. In the Quick Start tab, select React as the preferred technology.

  7. Since we are using a sample app, select Try out a sample option and follow the guide.

Running the sample apps

Follow the steps given below to run the sample:

  1. In the Quick Start guide, download the sample React application from the given link on the Asgardeo Console.

  2. Update the src/config.json configuration file with your registered app details.

    {
    "clientID": "",
    "baseUrl": "https://api.asgardeo.io/t/<org_name>",
    "signInRedirectURL": "https://localhost:3000",
    "signOutRedirectURL": "https://localhost:3000",
    "scope": [ "openid","profile" ]
}
    Attribute Description
    "clientID" The Client ID of your OIDC app.
    "baseUrl" Asgardeo server's host name along with your organization name.
    "signInRedirectURL" The URL to which the sample app redirects to after user login.
    "signOutRedirectURL" The URL which the sample app redirects to after user logout
    "scope" The list of OIDC scopes that are used for requesting user information. The openid scope is mandatory to get the ID token. You can add other OIDC scopes such as profile and email.

  3. Build and deploy the apps by running the following command at the root directory.

    npm install && npm start

  4. Go to https://localhost:3000 (or to the relevant URL you have hosted the sample app) on your browser.

Change the app's development server port

By default, the development server runs on port 3000. If you wish to change this to something else, follow the steps below.

  1. Update the PORT in the .env file in the app root.
  2. Update the signInRedirectURL and signOutRedirectURL parameters in src/config.json.
  3. Go to the Asgardeo Console, navigate to the Protocol tab of your application, and do the following:
    • Update the Authorized Redirect URL.
    • Update the Allowed Origins.

Other Links