This documentation is for WSO2 Identity Server 5.5.0. View documentation for the latest release.
Managing User Attributes - Identity Server 5.5.0 - WSO2 Documentation

All docs This doc
||
Skip to end of metadata
Go to start of metadata

When using the WSO2 Identity Server for user and role management, it is important to understand how to manage the attributes of users within it. In the Identity Server, each user store attribute can be mapped as a claim. Therefore, you need to use the claim management functionality available in the Identity Server and properly map your LDAP/AD/JDBC user store attributes with the claim URIs defined by the Identity Server. You can also add different claim URIs and manage them using claim management. 

The following topics provide instructions on how to manage user attributes in the Identity Server.

Managing the attributes of a user

The following are the three main ways to view, add, edit and delete attributes of a user in the Identity Server.

  1. By accessing the profile of the user and changing the attributes using the Management Console.
    1. Log into the WSO2 Identity Server.
    2. On the Main tab in the Management Console, click List under Users and Roles.
    3. Click Users. This link is only visible to users with the Admin role.
    4. From the list of users that appear in the resulting page, identify the user whose attributes you want to modify and click User Profile.
    5. Click Update to save changes to the attributes.
  2. You can use the REST Web service according to the SCIM provisioning specification. For more information on this, see Using the SCIM 2.0 REST APIs.
  3. You can use the RemoteUserStoreManagerService API. This is a SOAP-based API and is very easy to use. For more information on using this, see Managing Users and Roles with APIs. Supposing you want to set a user attribute, you can call the following method. 

    setUserClaimValue("username", "http://wso2.org/claims/emailaddress", "asela@soasecurity.org", null)

    Here “http://wso2.org/claims/emailaddress is the claim URI that has been mapped with the user store’s email attribute. The last parameter is profile, we can just pass “null”, as there is only one profile. You can retrieve the user attribute value as follows.

    getUserClaimValue("username", "http://wso2.org/claims/emailaddress", null)

Claim mapping when using multiple user stores

When you are using more than one user store, you must map the attributes correctly by adding a claim mapping. Under “Mapped Attribute(s)” you need to follow the pattern.

However, for the default user store, you do not need to provide the domain name. As an example, if you have two user stores, one is the default and another one with domain “DEMO” then the pattern would be as follows for “http://wso2.org/claims/emailaddress".

email;DEMO/mail

Attributes with multiple values

If your user store supports having multiple values for attributes, the WSO2 Identity Server can view, add, update or delete them (normally LDAP/AD offer support for this). The following are the different ways you can do this.

  1. In the Identity Server Management Console, multiple attribute values are separated by comma. If you want to update two email addresses using the user profile UI, you must provide it as follows.

    asela@soasecurity.com,aselapathberiya@soasecurity.com

    See the following screen for how this will look in the user interface of the Identity Server Management Console.
     

  2. When using the RemoteUserStoreManagerService API, call it as follows.

    setUserClaimValue("username", "http://wso2.org/claims/emailaddress", "asela@soasecurity.org,aselapathberiya@gmail.com", null)

    The GET results are returned in the form of comma separated values for the attribute.

    "asela@soasecurity.org,aselapathberiya@gmail.com"

    The following screen shows how this looks in the LDAP.
     

Writing custom attributes

Supposing the attributes of a user are stored in both the user store (LDAP) and another location (JDBC table), the Identity Server needs to retrieve/add the user’s attribute in both these places. In scenarios like this, some customization must be done. To customize this, you can simply extend the current user store manager implementation and write a custom implementation to do it. In the custom user store implementation, you only need to extend the following three methods that help to retrieve/add a user attribute. Other methods can be kept as they are.

  • Method 1.

    public Map<String, String> getUserPropertyValues(String userName, String[] propertyNames, String profileName) throws UserStoreException
  • Method 2.

    protected abstract void doSetUserClaimValue(String userName, String claimURI, String claimValue, String profileName) throws UserStoreException;
  • Method 3.

    protected abstract void doSetUserClaimValues(String userName, Map<String, String> claims, String profileName) throws UserStoreException;

See Writing a Custom User Store Manager for more information on this.

Authentication using multiple attributes

Multi attribute login is only supported for LDAP/AD user stores and is not supported for JDBC user stores.

WSO2 Identity Server can be deployed with any LDAP based server and it can expose authentication via a Web Service API, SAML, OAuth, OpenID, etc. By default, WSO2 IS is configured to authenticate with only one user attribute in the LDAP.

  • In a user store, each user has different attributes such as uid, cn, email, etc. Some attributes, such as uid and mail attributes, are unique to the user. 
  • Once you connect your LDAP with an application, generally, the application uses one of the unique attributes in LDAP to authenticate the user. 
  • This is done by specifying the attribute in the following property in the user-mgt.xml file found in the <IS_HOME>/repository/conf directory. For example, you can specify either the uid or mail attribute to authenticate the user. 

    <Property name="UserNameAttribute">uid</Property>

    In this case, the uid value is used as the username to authenticate the user in that application.

It is also possible for the application to use both attributes to authenticate. This means that end users can be authenticated in the application using either their uid or mail attribute values. This section provides instructions on how the WSO2 IS can be extended to authenticate users using more than one attribute. For the purposes of this example, assume that users are given the flexibility to authenticate using either their uid and mail attributes in the LDAP.

  1. Configure the LDAP user store related configurations using the user-mgt.xml file found in the <IS_HOME>/repository/conf directory. For more information on configuring user stores, see Configuring the Realm.
    1. Configure the UserNameSearchFilter property as shown below to search for the user object in the LDAP using both mail and uid attributes. 

      <Property name="UserNameSearchFilter">(&amp;(objectClass=person)(|(mail=?)(uid=?)))</Property> 
    2. Disable the UserDNPattern property if it is currently enabled.

      <!--Property name="UserDNPattern">uid={0},ou=Users,dc=wso2,dc=org</Property-->
    3. The mail attribute has unique requirements. If you are using the mail attribute, open the carbon.xml file found in the <IS_HOME>/repository/conf directory and uncomment the following. For more information on email authentication, see Using Email Address as the Username.

      <EnableEmailUserName>true</EnableEmailUserName>
  2. If you want to work with multiple attributes (basically to retrieve internal roles with multiple attributes), do one of the following depending on which user store you want to configure this for: 

    • Configuration for primary user store: Add the following property in the <IS_HOME>/repository/conf/user-mgt.xml file under the relevant UserStoreManager tag of the user store definition you are using. 

    • Configuration for secondary user store: Add the following property in the secondary user store configuration XML file. 

      <Property name="MultipleAttributeEnable">true</Property>
  3. To test this, restart WSO2 IS and attempt to log in to the management console by providing either the mail or uid values with the same password.

Customizing the claim for the user attribute

If you are using multiple attribute authentication and want to customize the claim to be used for user name attribute, do the following.

Edit the following element in the <IS_HOME>/repository/conf/identity/application-authentication.xml file.

<AuthenticatorConfig name="BasicAuthenticator" enabled="true">
	<Parameter name="UserNameAttributeClaimUri">http://wso2.org/claims/emailaddress</Parameter>
</AuthenticatorConfig>

This will return the email address of the authenticated user. It can be configured to return any attribute by changing the 'UserNameAttributeClaimUri' parameter.

Related Topics

For more information, see the following links.

  • No labels