Add LDAP data stores

LDAP based data stores can be used to augment application attribute data by accessing external LDAP data.
During this task we will add an LDAP based data store.

Steps

Add a data store

  1. Go to your Access Gateway Instance.
  2. Select the Settings tab.
  3. Click Data Stores.
  4. Click +.
  5. Click Sql Database to add an SQL database or LDAP Database to add an LDAP database.

Configure an LDAP data store

  1. When you create a data store for an LDAP database, provide the following information in the Create New DataStore wizard:
    FieldDescription
    NameName used to identify the data store (for example, My SQL Datastore).
    LDAP Connection StringURL to LDAP server and port (for example, ldap://myldap.example.com:10362).
    Bind UserUsername used to perform reads and writes. For example:

    CN=Administrator,CN=Users,DC=example,DC=com

    Bind User PasswordBind user password.
    Search DNThe base DN from which to perform the search. For example:

    CN=Users,DC=CN=Users,DC=example,DC=com=com

    Matching FilterThe filter used to match records returned from the Search DN. For example:

    (mail=${email@idp})

    Fields used in the Matching Filter clause must be defined as attributes for the application. If the field isn't listed as an application attribute, a runtime error occurs. Attributes used exclusively in Where clauses should be marked as don't send. See Manage application attributes.

  2. Click Not Validated. Okta Access Gateway attempts to validate the connection. If successful, the label changes to Valid.

Manage available fields

After validation, Okta Access Gateway add all fields from a data store to the Available Fields list.

To remove a field from the data store:

  1. Place the cursor directly before the field to be removed.
  2. Delete the field.

To add a field to the data store:

  1. Place the cursor anywhere in the list of fields.
  2. From the list of unused fields, click the name of a field to add it to the list of available fields.

Activate the data store

Turn on the Active toggle to activate the data store.

Test a data store

  1. Click Simulate (Data store simulate button.) in the row of the data store.
  2. For each field in the Matching Filter, enter a value.
  3. Click Test to run the simulation. Click Close to end.
  4. Check that the test returns the expected data from the data store for the given values.