Add a generic header application

The purpose of this tutorial is to step through the process of setting up a header application through the Access Gateway Admin 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.
  • The external app version is supported. Supported header app versions include:
    • Any that use HTTP Headers.
  • Appropriate DNS entries for both the header application and the external exposed new URL exist.

    ValueDescription
    https://application.headerapps.comLegacy application URL.
    https://gw-application.replaceinternal.comProtected application URL.

 

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 Header Based option from the application menu, and click Create.

    Select header based and click create.

    The New Protected Application wizard will start and display the Essentials pane for the application being added.

  5. In the Essentials pane, specify the following:

    Field Value
    Label A name for the application.
    Public Domain A fully qualified host name, such as gw-header-app.<your domain>
    Protected Web Resource The URL of the protected resources.
    Info

    Note

    Specifying a protected web resource of header.server.spgw tells Access Gateway to execute the header test suite. This is a special protected web resource.

    Group Enter the group containing the users who should have access to the application.
    Description Optional. An appropriate description for your application.
  6. Important Note

    Important

    While optional, Okta recommends that all applications include certificates.
    See About Access Gateway Certificates for general information about certificate.
    See Certificate management tasks for a general task flow for obtaining and assigning certificates.  

  7. Expand the Certificates tab.
    Note

    Note

    By default a wild card self signed certificate is created and assigned to the application when the application is initially created.

  8. Optional. Click Generate self-signed certificate

    A self-signed certificate is created and automatically assigned to the application.
  9. Optional. Select an existing certificate from the list of provided certificates.
    Use the Search field to narrow the set of certificates by common name.
    Use the page forward (>)and backward(<) arrows to navigate through the list of available certificates.

  10. Click Next. The Attributes pane appears.
  11. The Attributes pane provides a list of attributes that are passed into the application.
    You can also add, edit, or remove any attribute using this page. See Application attributes for more information on the attribute options.

  12. Add any required attributes, and click Next. The Policies pane appears.
  13. Leave all policies unchanged and click Done. See About application policy for more information on application policies.
  14. Click Next.

Define Okta tenant groups

You must define one or more groups representing the sections of your application being protected in your Okta tenant. See the Manage access control application policy guide for information on defining fine-grained access policy. You can also define additional attribute field values required by your application. However, they must be outside the values provided by default.

To define groups within your Okta tenant:

  1. Sign in to your Okta tenant as an administrator.
  2. In the Admin Console, go to Directory > Groups.
  3. Click Add Group.
  4. Click the name of the newly added group and use the various menu items to add members and manage group membership.
    See Users, Groups, and Profiles for more information on user and group management.

Associate the Access Gateway app with protected resource

With a tested Access Gateway application in place, the next step is to associate the application with a protected resource.
In this section, we will:

  • Associate a protected application with an external URL.
  • Associate one or more Okta tenant groups with an application.
  • Define one or more policies to protect portions of an application.
  1. Return to the Access Gateway Admin UI console

  2. Select the Application table.

    Info

    Note

    You can move directly to an application by clicking its name in the Topology tab.
    Topology tab to applications.

  3. In the row containing the header application, click Edit. Modify attribute(pencil) icon.

  4. If required, expand the Essentials pane.

  5. Replace the following values:

    Field Value Example
    Public Domain External DNS entry https://gw-application.externally-visible.com
    Protected Resource Internal protected resource https://legacy.protected.com
  6. In the Groups field, add groups associated with this application.

  7. Expand Advanced.

  8. Set advanced fields as required.

  9. Click Next.

Optional. Add attributes

To add an attribute, click the plus icon. Add attribute(plus) icon.
To delete an attribute, select its row and click the delete icon Delete attribute(trash can) icon.
To modify an existing attribute, select its row and click Edit. Modify attribute(pencil) icon.

For detailed information on the attribute options, see Application Attributes.

  1. Click the (+) icon
  2. From the Data Source drop-down box, select an appropriate data source.
  3. From the Field drop-down box, select a field name.
  4. From the Type drop-down box, select the appropriate target type as either Header or Cookie.
  5. In the Name field, enter the name for the header or cookie value expected by the legacy application.
    For example, to map the IDP field username to the header field login, create an attribute resembling:
    Example mapping of idP field login to to header field username.
  6. Click Okay when the attribute is complete.

Optional. Add policy

Info

Important

The root, represented by '/', is protected by Access Gateway by default. However, all users who can access the root can also access any subset of resources beneath the root. You can use a policy to protect subsets of the parent root URL.

See About application policyfor an overview of the user policy.
See Manage access control application policy for details and examples of policy.

 

To add a policy statement which protects an specific portion of an application,

  1. In the Policies tab, click the (+) icon.
  2. Select one of the following:
    Protected - Creates a policy rule that protects a specific URI.
    Unprotected - Creates a policy rule which marks a URL unprotected.
    Adaptive - Creates an adaptive policy rule.
    Protected Rule - Creates a Protected policy rule.
  3. Enter an appropriate Name for the rule.
  4. Enter the Resource Path to the URI being protected. 
    For example, a protected rule might protect the /secure URI.
  5. Depending on the rule type, enter additional details, such as Resource Matching Rule.

    For example, to create a rule that only allows users with a valid username value to access the /secure/ URL, create a Protected Rule with Resource Matching Rule regular expression username=* as shown.
    Example protected rule protecting the /secured/ resource.

  6. Repeat as required. Click Done when complete.

Test

The following steps assign the application to a test account and then execute the application to verify basic functionality.

Assign the application

  1. Sign in to your Okta tenant as administrator.

  2. In the Admin Console, go to Applications > Applications.

  3. Click the name of the newly added header application.

  4. Select the Assignments tab.

  5. Select .Assign > Assign To People.

  6. Select an appropriate user and click Assign.

    Info

    Note

    Usually, testing is initially done using the same user who is associated with administering Access Gateway.

  7. Click Done.

Execute the Application

  1. Return to the Access Gateway Admin UI console.

  2. On the row representing the newly added header app, select Goto application > IDP Initiated.

    add-sample-header-app-okta.09

  3. Verify that the results page displays all expected attribute values.
  4. Close the results page.

Related topics