Sample Header Application
Overview
The purpose of this tutorial is to walk through the process of setting up a sample header application through the Access Gateway AdminAn abbreviation of administrator. This is the individual(s) who have access to the Okta Administrator Dashboard. They control the provisioning and deprovisioning of end users, the assigning of apps, the resetting of passwords, and the overall end user experience. Only administrators have the Administration button on the upper right side of the My Applications page. Console.
Before You Begin
- Access Gateway is installed and configured for use.
See Deploy Access Gateway Using an OVA Image - Access Gateway has been configured to use your Okta tenant as iDPAn acronym for Identity Provider. It is a service that manages end user accounts analogous to user directories such as LDAP and Active Directory, and can send SAML responses to SPs to authenticate end users. Within this scenario, the IdP is Okta..
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 groupsGroups allow you to organize your end users and the apps they can access. Assigning apps to large sets of end users is made easier with groups..
-
Appropriate DNS entries exist for the application.
Create the Application in Access Gateway
-
Navigate to your Access Gateway instance and sign in as admin.
Note
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.
- Click the Applications tab
.
- Click + Add to add a new application.
-
Select the Access Gateway Sample Header AppAn abbreviation of application. Essentially, it is a web-based site used to perform any number of specific tasks, and requires authentication from end users by signing in. 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.
-
Review the Settings tab then click Next.
Note
The Settings page provides options with which to further configure the application.
For more information on the application setting options, see Application Settings.
.
-
Click Next.
Note
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, see Application Attributes .
Add a Custom Attribute to Okta
-
In a new tab, Navigate to your Okta OrgThe Okta container that represents a real-world organization. and sign in as an Administrator.
-
Click Directory > Profile Editor.
- Click Profile in the Actions column.
- Click + Add Attribute to add a custom attribute that will be used to send header information through the Sample Header Application.
- Enter a Display name, for example Gender ,and an appropriate Variable name, again for example gender. Click Save.
- Click Directory > People.
- Select your account under the Person & Username column.
- Click the Profile tab, and click Edit.
- Scroll down to the new attribute, in this example Gender, and enter a corresponding value.
- Click Save.
Complete the Header Application Configuration
-
Return to the Access Gateway Admin Console.
-
Select the new application and click the pencil icon.
-
In the Attributes section, click the +.
-
Scroll down to the Add new Session Attribute window.
-
In the Name field, enter manager, and select the manager attribute type in the Value field.
-
Click Okay.
Note
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.
- Click Next.
- Click Done.
- Confirm that the Sample Header App is displayed as Active in the Protected Applications list.
- Click the Goto App icon.
Important
Ensure that the Public DomainA domain is an attribute of an Okta organization. Okta uses a fully-qualified domain name, meaning it always includes the top-level domain (.com, .eu, etc.), but does not include the protocol (https). 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> xxx.xxx.xxx.xxx header.gateway.info
Test the Sample Header Application
-
Select IDP Initiated from the drop down menu to verify the application is working.
Note
Your Okta tenant administrator will need to assign the header application to you.
- In the application page, review and verify that the Sample Header App sent to Okta matches your profile information.
Next Steps
- Add or review application settings. For more details see Application Settings.
- Add application behaviors. For details and examples of behaviors see Administer Behaviors.
- Add fine grained policy to further protect resources.
An overview of user policy can be found in Application Policy User Overview.
For details and examples of policy see Administration User Policy Guide. - Extend existing policy using Custom configuration, see Advanced Policy.
- Define one or more certificates for use with this application. See Certificate Management
- Add supplemental database or LDAPLightweight Directory Access Protocol (LDAP) is a lightweight client-server protocol for accessing directory services, specifically X.500-based directory services. LDAP runs over TCP/IP or other connection oriented transfer services. based data stores. For more information see Administer DataStores