Integrate Data Stores

You can add, modify, delete, and manage data stores in the Access Gateway Admin UI console.

You can use data stores to:

• Augment the Access Gateway session data using external data sources, such as a database or Lightweight Directory Access Protocol (LDAP).
• Support bidirectional synchronization between Access Gateway and external data sources.
• Support databases (for example, MySQL, MS SQL, Oracle, and Postgres).
• Support LDAP (for example, any LDAP V3 compliant Active Directory, Oracle Internet Directory/Unified Directory, OpenLDAP, and others).

After you select Sql Database, the Create New DataStore wizard starts and is initialized for database creation.

1. Enter the following details:

   Field	Description	Example
   Name	The name used to identify the data store.	My SQL Datastore
   Driver	Driver for datastore. Select any one of the following: MySQL/MariaDB PostgreSQL MSSQL Server OracleDB	MySQL/MariaDB
   HostName:Port	Enter the FQDN and port for the database instance.	mysqlserver.example.com:3306
   Database	Name of the database (schema) within the database.	userDatabase
   Username	Username to access the database.	dbuser
   Password	Password associated with Username.	password
   Advanced Query Mode	Disabled: Specify the table name.	people

2. Click Not Validated to start the validation process. Okta Access Gateway validates the connection to the database. If the validation was successful, the button changes to Valid to show that the connection is valid.
3. Add a Where clause that defines the join between your Okta tenant and the database.
   1. Click Add (+).

      

   2. In the Clause Conditions dialog box, enter the following:

      Field	Value	example
      Field	The database field to join with	email
      Value	The IDP field to join against	${email@idp}

      The Value field can contain a fixed value or a reference to a field within a data store. The most common use is ${fieldInIdP@idp}. Here, fieldInIdP represents the field used to join against the table and is from the fields available in the IDP profile.

   3. Click Save (). Repeat the previous two steps as required to add more clause conditions.
   4. Click Okay to save the data store definition.

   Define the fields used in the Where clause as attributes for the application. If you use a field that's not defined as an application attribute, it results in an error.

4. Turn on the Active toggle to activate the data store.
5. Test the datasource.
   1. In the row containing the data store, click Test ( ).
   2. In the Value field, enter a value that's matched in the where clause of the data store. For example, if matching on email, enter a valid email address.
   3. Click Test.
   4. On success, the data store test displays content in the Loaded Data section of the test dialog box. If no matches are found, then the dialog box doesn't display any information.