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 Console.

Before you begin

  • 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 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. Navigate to your Access Gateway instance and sign in as admin.



    Access Gateway creates a default self-signed certificate. For non-production deployments, this will be appropriate. Proceed past any security exceptions raised by your browser. For production deployments, a valid certificate can be installed and these exceptions will not be needed.

  2. Click the Applications tab

    .Select applications tab
  3. Click + Add to add a new application.
    Click Add.
  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.

    For more information on the application setting , see About application settings.


  6. Click Next.



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

    For more information on the attribute options, seeApplication attributes.

Add a custom attribute to Okta

  1. In a new tab, Navigate to your Okta Org and sign in as an Administrator.

  2. Click Directory > Profile Editor.

  3. Click Profile in the Actions column.
  4. Click + Add Attribute to add a custom attribute that will be used to send header information through the Sample Header Application.
  5. Enter a Display name, for example Gender ,and an appropriate Variable name, again for example gender. Click Save.
  6. Click Directory > People.
  7. Select your account under the Person & Username column.
  8. Click the Profile tab, and click Edit.
  9. Scroll down 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 Console.

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


  3. In the Attributes section, click the +.


  4. Scroll down to the Add new Session Attribute window.

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

  6. Click Okay.




    In the Value menu, type in the name of the attribute you want to add, and then click the new attribute in the dropdown menu.

  7. Click Next.
  8. Click Done.
  9. Confirm that the Sample Header App is displayed as Active in the Protected Applications list.
  10. Click the Goto App icon.


    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. Select IDP Initiated from the drop down menu to verify the application is working.

    Test sample header app



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

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

See Also