This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Configuring a Read-write Active Directory User Store
- Former user (Deleted)
- Former user (Deleted)
- Gomathy Kumarakuruparan (Unlicensed)
Before you begin!
Please read following topics:
For Read-only Active Directory User Store manager configuration, use Read-only LDAP user store manager configuration properties.
Read-Write Active Directory User Store manager is configured with org.wso2.carbon.user.core.ldap.ActiveDirectoryUserStoreManager user store manager class.
In this page, you can find information on:
Properties used in Read-write Active Directory userstore manager
The following table lists the properties used in Read-write Active Directory and their descriptions:
| Property Name | Display Name | Description |
|---|---|---|
| ConnectionURL | Connection URL | Connection URL to the user store server. In the case of default LDAP in Carbon, the port is specified in the Sample values: For information on how to add certificates to the truststore and how keystores are configured and used in a system, see Using Asymmetric Encryption doc in https://docs.wso2.com/display/ADMIN44x/Using+Asymmetric+Encryption If LDAP connection pooling is used, see enable connection pooling for LDAPS connections. |
| ConnectionName | Connection Name | The username used to connect to the user store and perform various operations. This user does not have to be an administrator in the user store or have an administrator role in the WSO2 product that you are using, but this user MUST have permissions to read the user list and users' attributes and to perform search operations on the user store. The value you specify is used as the DN (Distinguish Name) attribute of the user. This property is mandatory. Sample values: uid=admin,ou=system |
| ConnectionPassword | Connection Password | Password for the ConnectionName user. |
| UserSearchBase | User Search Base | Distinguish Name (DN) of the context or object under which the user entries are stored in the user store. When the user store searches for users, it will start from this location of the directory. Sample values: ou=Users,dc=wso2,dc=org |
| UserEntryObjectClass | User Entry Object Class | Object class used to construct user entries. Default: wso2Person (Is a custom object class defined in WSO2 products) |
| UserNameAttribute | Username Attribute | The attribute used to uniquely identify a user entry. Users can be authenticated using their email address, UID, etc. The name of the attribute is considered as the username. Sample values: uid |
| UserNameSearchFilter | User Search Filter | Filtering criteria used to search for a particular userentry. Sample values: (&(objectClass=person)(uid=?)) |
| UserNameListFilter | User List Filter | Filtering criteria for searching user entries in the user store. This query or filter is used when doing search operations on users with different search attributes. Sample values: (objectClass=person) In this case, the search operation only provides the objects created from the person object class. |
| UserDNPattern | User DN Pattern | The pattern for the user's DN, which can be defined to improve the search. When there are many user entries in the LDAP user store, defining a UserDNPattern provides more impact on performances as the LDAP does not have to travel through the entire tree to find users. Sample values: uid={0},ou=Users,dc=wso2,dc=org |
| DisplayNameAttribute | Display Name Attribute | This is an optional property. The Display Name Attribute is the name by which users will be listed when you list users in the management console. |
| Disabled | ||
| ReadGroups | Read Groups | When WriteGroups is set to falses, this Indicates whether groups should be read from the user store. If this is disabled by setting it to false, none of the groups in the user store can be read, and the following group configurations are NOT mandatory: GroupSearchBase, GroupNameListFilter, or GroupNameAttribute. Possible values: true : Read groups from user store false : Don’t read groups from user store |
| WriteGroups | Write Groups | Indicates whether groups should be write to the user store. Possible values: true : Write groups to user store false : Don’t write groups to user store, so only internal roles can be created. Depend on the value of ReadGroups property, it will read existing groups from user store or not |
| GroupSearchBase | Group Search Base | Distinguish Name (DN) of the context or object under which the group entries are stored in the user store. When the user store searches for groups, it will start from this location of the directory. Sample values: ou=Groups,dc=wso2,dc=org |
| GroupEntryObjectClass | Group Entry Object Class | Object class used to construct group entries. Sample values: groupOfNames |
| GroupNameAttribute | Group Name Attribute | Attribute used for uniquely identifying a group entry. This attribute is to be treated as the group name. |
| GroupNameSearchFilter | Group Search Filter | Filtering criteria used to search for a particular group entry. Sample values: (&(objectClass=groupOfNames)(cn=?)) |
| GroupNameListFilter | Group List Filter | Filtering criteria for searching group entries in the user store. This query or filter is used when doing search operations on groups with different search attributes. Sample values: ((objectClass=groupOfNames)) In this case, the search operation only provides the objects created from the groupOfName object class. |
| RoleDNPattern | Role DN Pattern | The pattern for the group's DN, which can be defined to improve the search. When there are many group entries in the LDAP user store, defining a RoleDNPattern provides more impact on performances as the LDAP does not have to travel through the entire tree to find group. Sample values: cn={0},ou=Groups,dc=wso2,dc=org |
| MembershipAttribute | Membership Attribute | Define the attribute that contains the distinguished names (DN ) of user objects that are in a group Possible values: member |
| MemberOfAttribute | Member Of Attribute | Define the attribute that contains the distinguished names (DN) of group objects that user is assigned to. Possible values: memberOf |
| BackLinksEnabled | Enable Back Links | Define whether the backlink support is enabled. If you are using MemberOfAttribute attributes this should be set to true. |
| referrel | ||
| UsernameJavaRegEx | Username RegEx (Java) | The regular expression used by the back-end components for username validation. By default, strings with non-empty characters have a length of 3 to 30 allowed. You can provide ranges of alphabets, numbers and also ranges of ASCII values in the RegEx properties. Default: [a-zA-Z0-9._-|//]{3,30}$ |
| UsernameJavaScriptRegEx | Username RegEx (Javascript) | The regular expression used by the front-end components for username validation. Default: ^[\S]{3,30}$ |
| UsernameJavaRegExViolationErrorMsg | Username RegEx Violation Error Message | Error message when the Username is not matched with UsernameJavaRegEx |
| PasswordJavaRegEx | Password RegEx (Java) | The regular expression used by the back-end components for password validation. By default, strings with non-empty characters have a length of 5 to 30 allowed. You can provide ranges of alphabets, numbers and also ranges of ASCII values in the RegEx properties. Default: ^[\S]{5,30}$ |
| PasswordJavaScriptRegEx | Password RegEx (Javascript) | The regular expression used by the front-end components for password validation. Default: ^[\S]{5,30}$ |
| PasswordJavaRegExViolationErrorMsg | Password RegEx Violation Error Message | Error message when the Password is not matched with passwordJavaRegEx |
| RolenameJavaRegEx | Role Name RegEx (Java) | The regular expression used by the back-end components for role name validation. By default, strings with non-empty characters have a length of 3 to 30 allowed. You can provide ranges of alphabets, numbers and also ranges of ASCII values in the RegEx properties. Default: [a-zA-Z0-9._-|//]{3,30}$ |
| PasswordJavaScriptRegEx | Password RegEx (Javascript) | The regular expression used by the front-end components for password validation. Default: ^[\S]{5,30}$ |
| SCIMEnabled | Enable SCIM | This is to configure whether user store is supported for SCIM provisioning. Possible values: True : User store support for SCIM provisioning. False : User does not store support for SCIM provisioning. |
| BulkImportSupported | Bulk Import Support | Define whether the user store supports for bulk user import operation |
| EmptyRolesAllowed | Allow Empty Roles | Specifies whether the underlying user store allows empty groups to be created. In the case of LDAP in Carbon, the schema is modified such that empty groups are allowed to be created. Usually, LDAP servers do not allow you to create empty groups. |
| PasswordHashMethod | Password Hashing Algorithm | Specifies the Password Hashing Algorithm used the hash the password before storing in the userstore. Possible values: SHA - Uses SHA digest method. SHA-1, SHA-256 MD5 - Uses MD 5 digest method. PLAIN_TEXT - Plain text passwords. If you just configure as SHA , It is consider as SHA-1, It is always better to configure algorithm with higher bit value as digest bit size would be increased. Most of the LDAP servers (such as OpenLdap, OpenDJ, AD, ApacheDS and etc..) are supported to store password as salted hashed values (SSHA) Therefore WSO2IS server just wants to feed password into the connected user store as plain text value. Then LDAP user store can stored them as salted hashed value. To feed the plain text into the LDAP server, you need to set PasswordHashMethod to “PLAIN_TEXT” But; if your LDAP does not support to store user password as hashed values. You can configure WSO2 server to hash the password and feeds the hashed password in to the LDAP server. Then you need to configure PasswordHashMethod property with SHA (SHA-1), SHA-256, SHA-512. Please note WSO2 server can not create a salted hashed password (SSHA) to feed into the LDAP. |
| MultiAttributeSeparator | Multiple Attribute Separator | This property is used to define a character to separate multiple attributes. This ensures that it will not appear as part of a claim value. Normally “,” is used to separate multiple attributes, but you can define ",,," or "..." or a similar character sequence Default: “,” |
| isADLDSRole | Is ADLDS Role | Enable only if user store is a AD LDS (Active Directory Lightweight Directory Services) Default: false |
| userAccountControl | User Account Control | Define Active directory UserAccountControl Attribute/Flag Values Default: 512 (normal_account) |
| MaxUserNameListLength | Maximum User List Length | Controls the number of users listed in the user store of a WSO2 product. This is useful when you have a large number of users and don't want to list them all. Setting this property to 0 displays all users. Default: 100 In some user stores there are policies to limit the number of records that can be returned for query, Setting the value 0 it will list the maximum results return by the user store. If you need to increase that you need to set it in the user store level. Eg : Active directory has the MaxPageSize property with the default value 1000. |
| MaxRoleNameListLength | Maximum Role List Length | Controls the number of roles listed in the user store of a WSO2 product. This is useful when you have a large number of roles and don't want to list them all. Setting this property to 0 displays all roles. Default: 100 In some user stores there are policies to limit the number of records that can be returned for query, Setting the value 0 it will list the maximum results return by the user store. If you need to increase that you need to set it in the user store level. Eg : Active directory has the MaxPageSize property with the default value 1000. |
| kdcEnabled | Enable KDC | If your user store is capable of acting as a Kerberos, Key Distribution Center (KDC) and if you like to enable it, set this property to true. Default: false |
| UserRolesCacheEnabled | Enable User Role Cache | This is to indicate whether to cache the role list of a user. Default: true Possible values: false : Set it to false if the user roles are changed by external means and those changes should be instantly reflected in the Carbon instance. |
| ConnectionPoolingEnabled | Enable LDAP Connection Pooling | Define whether LDAP connection pooling is enabled Possible values: |
| LDAPConnectionTimeout | LDAP Connection Timeout | Timeout in making the initial LDAP connection. This is configured in milliseconds. Default: 5000 |
| ReadTimeout | LDAP Read Timeout | The value of this property is the read timeout in milliseconds for LDAP operations. If the LDAP provider cannot get a LDAP response within that period, it aborts the read attempt. The integer should be greater than zero. An integer less than or equal to zero means no read timeout is specified which is equivalent to waiting for the response infinitely until it is received. Default: 5000 |
| RetryAttempts | Retry Attempts | Retry the authentication request if a timeout happened Default: 0 |
| CountRetrieverClass | Count Implementation | This define the user / role count retriever implementation class (Only supported for ) Possible values: JDBC : org.wso2.carbon.identity.user.store.count.jdbc.JDBCUserStoreCountRetriever |
| java.naming.ldap.attributes.binary | LDAP binary attributes | Set the attribute that need to store in the binary format. Sample values: objectGUID |
| MembershipAttributeRange | Membership Attribute Range | This is used to define the maximum users of role returned by the LDAP/AD user store. This does not depend on the max page size of the user store. Default: 1500 |
| StartTLSEnabled | Enable StartTLS | This defines whether startTLS is enabled or not. By default this is set to 'False'. If this is set to 'True', the StartTLS extended operation establishes a secure connection in the LDAP server. More information on this configuration can be found in Configuring StartTLS Communication with an external LDAP server. |
| ImmutableAttributes | Immutable Attributes | This is a comma-separated list of immutable attributes that are maintained in the user store. Default: not configured |
| TimestampAttributes | Timestamp Attributes | This is a comma-separated list of user store attributes that have the data type of Timestamp and may require a conversion when reading from/writing to user store. Default: not configured |