Register a SAML web app

# Register a SAML web app

To integrate your web application with Asgardeo using SAML (opens new window), you need to first register your application as a SAML application in Asgardeo.

There are two ways to provide your SAML application configurations to Asgardeo during registration:

  • Use a SAML SP metadata file
  • Add SAML SP configurations manually

Follow the instructions given below.

# Register the app

To register the app:

  1. On the Asgardeo Console (opens new window), click Applications.

    Select app type in Asgardeo
  2. Click New Application and select Traditional Web Application.

  3. In the Name field, enter a unique name to identify your application.

  4. Select the SAML protocol.

  5. Select one of the following methods and add the SAML configurations:


    Use this option to manually specify the required SAML configurations.

    See Add SAML configs manually.
    File Based

    Upload a SAML metadata file with the required configurations.

    See Use a SAML metadata file.
    URL Based

    Point to the endpoint with the SAML metadata.

    See Use a SAML metadata file.
    Allow sharing with sub-organizations Enable this to share the new application with all or any selected suborganizations that belong to your root organization.
  6. Click Register to complete the registration.

    If you have enabled Allow sharing with sub-organizations while registering the application, you will see a popup window with the following options.

    Share the application with suborganizations
    Option Description
    Share with all sub-organizations If selected, the application will be shared with all existing suborganizations and any new suborganizations you may create in the future.
    Share with only selected sub-organizations If selected, you can select the suborganizations you wish to share the application with.

# Add SAML configs manually

If you selected Manual in the previous step, you can manually specify the SAML configurations as follows:

Register SAML app
Parameter Description
Issuer The unique identifier of the application. The value added here should be specified in the SAML authentication request as saml:Issuer element sent from the client application. You can't change this issuer configuration after you register the app.
Assertion consumer service URLs The URLs to which the browser is redirected to upon successful authentication. This receives the SAML response.

# Use a SAML metadata file

An SP metadata XML file contains the following:

  • SP certificate
  • The entity ID (also known as issuer)
  • Assertion Consumer Service URLs (ACS URLs)
  • Single Logout Service URLs

There are two ways to use a SAML metadata file during application registration:

  • Select the File Based option and upload the SAML SP metadata file.

    Register SAML app using metadata file
  • Select the URL Based option and specify the SAML meta URL, which refers to the endpoint that hosts the SAML metadata file.

    Register SAML app using meta url

# What's next?