Add a sample header application

The purpose of this tutorial is to walk through the process of setting up a sample header application through the Access Gateway Admin UI console.

Before you begin

Ensure that:

  • Access Gateway is installed and configured for use.
    See Manage Access Gateway deployment.
  • Access Gateway has been configured to use your Okta tenant as IDP.
    See Configure your Okta tenant as an Identity Provider for more information about configuring your Okta tenant as an IDP.
  • You have administrator rights on your Okta tenant and can assign applications to users and create groups.
  • Appropriate DNS entries exist for the application.

Create the application in Access Gateway

  1. Sign in to the Access Gateway Admin UI console.
  2. Click the Applications tab.

  3. Click +Add to add a new application.

  4. Select the Access Gateway Sample Header App option from the left column menu, and click Create.


    The New Protected Application wizard will start and display the Setting tab for the application being added.

  5. Review the Settings tab then click Next.



    The Settings page provides options with which to further configure the application.

    See About application settings for more information on the application settings.


  6. Click Next.



    The Attributes page provides a list of attributes that are passed into the application. This page also provides the ability to add, edit, or remove any attribute.

    SeeApplication attributes for more information on the attribute options.

Add a custom attribute to Okta

  1. In a new tab, navigate to your Okta org and sign in as an administrator.

  2. In the Admin Console, go to Directory >Profile Editor.

  3. In the Actions column, click Profile.
  4. Click + Add Attribute to add a custom attribute used to send header information through the Sample Header Application.
  5. Enter a Display name and an appropriate Variable name. For example, the display name can be , for example, Gender and the variable can be gender. Click Save.
  6. In the Admin Console, go to Directory > People.
  7. Select your account under the Person & Username column.
  8. Click the Profile tab, and click Edit.
  9. Go to the new attribute, in this example Gender, and enter a corresponding value.
  10. Click Save.

Complete header application configuration

  1. Return to the Access Gateway Admin UI console.

  2. Select the new application and click the Edit icon.


  3. In the Attributes section, click the +.


    The Add new Attribute window opens after the list of existing attributes.

  4. In the Name field, enter manager and in the Value field, select the attribute type as manager.

  5. Click Okay.




    In the Value menu, enter the name of the attribute you want to add, and click the new attribute in the drop-down menu.

  6. Click Next.
  7. Click Done.
  8. Confirm that the sample header app is displayed as Active in the Protected Applications list.
  9. Click Goto application.


    Ensure that the Public Domain defined in the Configure the Header Application Settings is added to local host file or DNS Server pointing to the VM running Access Gateway. For example:

    <ip address>     <app public domain>



Access Gateway inserts the cookie header into the request before it is sent to the back-end web application.


  1. Click Goto application and select IDP Initiated to verify that the application is working.

    Test sample header app



    Your Okta tenant administrator will need to assign the header application to you.

  2. On the application page, review and verify that the sample header app sent to Okta matches your profile information.
    Sample header app test

Related topics