8 Configuring the Identity Store

This chapter explains how to configure and use the identity store, and how to query it programmatically.

This chapter includes the following sections:

See also:

About the Identity Directory Service in Developer's Guide for Identity Governance Framework

8.1 About the Identity Store

The identity store stores users and groups, and the service lets you query that data. By default, it supports querying a single LDAP identity store. You can configure the service to use a virtualized identity store that lets you query multiple LDAP identity repositories instead of just one. For information about identity virtualization, see Section 8.3, "Configuring the Identity Store."

Depending on the configuration, the service uses a file or (one or more) LDAP servers as the repository of identities. When the service is configured for LDAP, by default, it queries a single LDAP, but you can configure the service to query multiple LDAPs.

The service is available in Java SE environments. For information about virtualization in Java SE applications, see Section 8.3.5, "Configuring Virtualization in Java SE Applications."

8.2 Configuring the Identity Store Provider

Before using the identity store, you must configure the identity store provider. OPSS supports both file and LDAP identity store providers, as the following configuration example illustrates:

<serviceProvider type="IDENTITY_STORE" name="idstore.ldap.provider" 
      <description>LDAP IdentityStore Provider</description>
<serviceProvider type="IDENTITY_STORE" name="idstore.xml.provider" 
      <description>XML-based IdentityStore Provider</description>

If you set Active Directory as the identity store provider, then set the USERNAME_ATTR and USER_LOGIN_ATTR properties to sAMAccountName in jps-config.xml (or jps-config-jse.xml) if you want to override the default value (cn). For example:

<property value="sAMAccountName" name="username.attr"/>
<property value="sAMAccountName" name="user.login.attr"/>


If you set virtualize to true, then do not set the user.login.attr and username.attr properties.

8.3 Configuring the Identity Store

The following sections explain how to configure the identity store:

8.3.1 Identity Store Parameters

The following sections explain the use of the identity store configuration parameters: Query Parameters

Use the following parameters to configure queries to multiple LDAPs:

  • The virtualize property - This property can be either true (multiple LDAPs lookup) or false (single LDAP lookup). If unspecified, it defaults to false.

  • Global Connection Parameters (when the virtualize property is enabled) - The calling application uses these parameters to specify global LDAP configuration such as the search base, create base, and so on. If any of these parameters is unspecified, then OPSS uses a default value.

  • Back-end Connection Parameters - These parameters are specific to each LDAP store. One set of back-end parameters is specified for each LDAP. You do not need to set these parameters unless you want to overwrite default values. Global Connection Parameters

Table 8-1 shows the global parameters. For a list of connection pool parameters, see section Understanding Configuration Parameters in Developer's Guide for Identity Governance Framework.

Table 8-1 Global LDAP Identity Store Parameters

Parameter Default Value


same as user.create.bases




No default value






No default value


No default value


No default value




No default value


No default value


If only one authentication provider, then it uses the create base value. If multiple ones, then no default value is set.






No default value




Same as group.search.bases


cn Back-End Connection Parameters

These parameters are specific to your particular LDAP store.

8.3.2 Understanding the Service Configuration

LDAP authentication providers are configured with Oracle WebLogic Server Administration Console or WebLogic Scripting Tool (WLST). At runtime, the server passes the configuration details to OPSS.

In WebLogic Server domains, you can configure multiple authentication providers in a given context. By default, the first authentication provider in the list is used to initialize the identity store. For information about authentication providers, see Section, "Support for Multiple Authentication Providers."

To query multiple LDAPs requires setting up the virtualize property.

The following sections explain several configurations: Configuring the Service for a Single LDAP

The following example illustrates the configuration of a single LDAP service instance:

<!-- JPS WLS LDAP Identity Store Service Instance -->
        <serviceInstance name=idstore.ldap provider=idstore.ldap.provider>
            <property name=idstore.config.provider                       value=oracle.security.jps.wls.internal.idstore.
            <property name=CONNECTION_POOL_CLASS                       
        </serviceInstance> Configuring the Service for Multiple LDAPs without Virtualization

In cases when the virtualize property cannot be set, configure the service to query more than one LDAP and override the configuration in WebLogic Server. To specify multiple LDAPs, use a comma separated list of LDAP URLs:

<property name="ldap.url", value="ldap://host1:port1,ldap://host2:port2"/> Configuring the Service for Multiple LDAPs with Fusion Middleware Control

To configure the service for multiple LDAPs with Fusion Middleware Control:

  1. Choose the domain in the navigation pane on the left.

  2. Go to Security, then Security Provider Configuration.

  3. Expand the Identity Store Provider section of the page.

  4. Click Configure.

  5. The Identity Store Configuration page appears.

  6. Under Custom Properties, click Add.

  7. Add the new property:

    Property Name=virtualize

    Be sure to also add this property to the service instance in the default context of the OPSS configuration file.

  8. Click OK. Configuring the Service with WLST

To configure and use virtualization using WLST:

  1. Create a script file to connect to the Administration Server in the domain of interest. You must specify the userName, userPass, localHost, and portNumber attributes for this operation. For information about configuring services with scripts, See Appendix E, "Configuring Services with Scripts."

  2. Go to $ORACLE_HOME/common/bin.

  3. Run wlst.sh.

    For example, if the domain configuration file contains the idstore.ldap authentication provider, then the following command configures the provider for multiple LDAPs lookup:

    wlst.sh /tmp/updateServiceInsta, nceProperty.py -si idstore.ldap 
    -key "virtualize" -value "true" Configuring the Timeout Setting with WLST

To set adapter timeout using WLST:

  1. Run the listAdapters command to obtain the list of adapters.

  2. Run the modifyLDAPAdapter command to set the timeout for each adapter to, for example, 120 seconds:

    modifyLDAPAdapter('<ADAPTER NAME>', 'OperationTimeout', 120000)

  3. Restart WebLogic Server.

See also:

modifyLDAPAdapter in Developer's Guide for Identity Governance Framework Configuring Other Parameters

Optionally, update the configuration in the jps-config.xml file to set query parameters listed in Section 8.3.1, "Identity Store Parameters". These parameters are optional and have default values. Restarting Servers

After configuring queries to multiple LDAPs, restart WebLogic Administration Server and Managed Servers. Configuring Single and Multiple LDAPs

The following example illustrates the configuration of a single LDAP:

        <serviceInstance name=idstore.ldap provider=idstore.ldap.provider>
            <property name=idstore.config.provider                       value=oracle.security.jps.wls.internal.idstore.
            <property name=CONNECTION_POOL_CLASS                       

The following example illustrates the configuration of a multiple LDAPs:

        <serviceProvider type="IDENTITY_STORE" name="idstore.ldap.provider" 
            <description>LDAP IdentityStore Provider</description>
        <!-- IDstore instance connecting to multiple ldap  -->
        <serviceInstance name="idstore.virtualize" provider="idstore.ldap.provider">
        <!-- indicates using WLS ldap authentication providers -->
            <property name="idstore.config.provider" 
            <!-- enable virtualization -->
            <property name="virtualize" value="true"/>
    <!-- ldap properties (if not supplied, then it uses default values) --> 
  <jpsContexts default="default">
        <!-- the identity store uses multiple ldaps -->
        <jpsContext name="default">
            <!-- use multiple ldap -->
            <serviceInstanceRef ref="idstore.virtualize"/>    
            <!-- .....other services -->

Note that:

  • The virtualize property of the service instance is true, and this allows queries to multiples LDAP directories.

  • The extendedProperty element allows you to set front-end parameters to override default values.

See also:

Front-End Parameters in Section 8.3.1, "Identity Store Parameters"

8.3.3 Configuring Split Profiles

Identity virtualization supports split profiles, which lets applications access identity attributes when they are stored in more than one LDAP repository.

This feature requires additional configuration explained in Appendix I, "Adapter Configuration for Identity Virtualization."

8.3.4 Configuring Custom Authentication Providers

OPSS supports WebLogic Authentication providers to access identities. If the available providers are not suitable to your particular LDAP server, then, typically, you customize one. This section explains how to configure and use a custom authentication provider.

When using a custom LDAP authentication provider, the following configuration illustrates how to specify the LDAP type so that the provider can find the proper LDAP plug-in by overriding idstore.type in jps-config.xml:

<serviceInstance name="idstore.ldap" provider="idstore.ldap.provider">
    <property name="idstore.config.provider"
    <property name="CONNECTION_POOL_CLASS"
value="oracle.security.idm.providers.stdldap.JNDIPool" />
    <property value="true" name="virtualize" />
    <serviceInstanceRef ref="myGenericLDAPName"/>
  <serviceInstance name="myGenericLDAPName" provider="idstore.ldap.provider">
    <!-- overrides the 'idstore.type' property -->
    <property name="idstore.type" value="ACTIVE_DIRECTORY" />

To override additional LDAP provider instances, insert similar entries. For information about provider configuration, see Section 9.6, "Configuring Security Providers with Fusion Middleware Control."

8.3.5 Configuring Virtualization in Java SE Applications

For Java SE applications, you set all configurations in the jps-config-jse.xml file. According to your needs, edit this file to:

  1. Define a new service instance.

  2. Add the new service instance to the context and replace any previously defined instances.

  3. Enable virtualize.

8.4 Querying the Identity Store Programmatically

To programmatically query the identity store, use OPSS APIs to obtain a context. This context acts like a bridge to obtain the store instance. Subsequently you use the User and Role API to query the store instance:

 try {
         //find the JPS context
         JpsContextFactory ctxFactory = JpsContextFactory.getContextFactory();
         JpsContext ctx = ctxFactory.getContext();
         //find the JPS IdentityStore service instance 
         //(assuming the back-end is ldap type)
         LdapIdentityStore idstoreService = (LdapIdentityStore)ctx.getServiceInstance(IdentityStoreService.class)

         //get the User/Role API's Idmstore instance
          oracle.security.idm.IdentityStore idmIdentityStore = idstoreService.getIdmStore();
        //use the User/Role API to query ID store

//alternatively, instead of using IdentityStore, use the 
//IdentityDirectory to access LDAP
oracle.igf.ids.IdentityDirectory ids = idstoreService.getIdentityStore();
 } catch (Exception e) {

8.5 Configuring SSL for the Identity Store

You can use Secure Sockets Layer (SSL) connections between the identity store and the LDAP server(s). Both the Identity Directory API and the User and Role API can operate with multiple LDAPs.

When the connection to the identity store originates at a client in WebLogic Server, then the SSL configuration is handled by the server.