This documentation is for WSO2 Identity Server 5.1.0 . View documentation for the latest release.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Sign in. Enter your username and password to log on to the management console
  2. Navigate to the Main menu to access the Identity menu. Click Add under Service Providers.
  3. Fill in the Service Provider Name and provide a brief Description of the service provider. Only Service Provider Name is a required field and we use Salesforce as the name for this example.
     
  4. Click Register.
  5. Expand the Inbound Authentication Configuration and the SAML2 Web SSO Configuration and click Configure.
  6. In the form that appears, fill out the following configuration details required for single sign-on.
     See the following table for details.

    FieldValueDescription
    Issuerhttps://saml.salesforce.comThis is the <saml:Issuer> element that contains the unique identifier of the service provider. This is also the issuer value specified in the SAML Authentication Request issued by the service provider. When configuring single-sign-on across Carbon servers, ensure that this value is equal to the ServiceProviderID value mentioned in the <IS_HOME>/repository/conf/security/authenticators.xml file of the relying party Carbon server.
    Assertion Consumer URLhttps://identityprovisioning-dev-ed.my.salesforce.com?so=00D90000000ySEnThis is the URL to which the browser should be redirected to after the authentication is successful. This is the Assertion Consumer Service (ACS) URL of the service provider. The identity provider redirects the SAML2 response to this ACS URL. However, if the SAML2 request is signed and SAML2 request contains the ACS URL, the Identity Server will honor the ACS URL of the SAML2 request. It should have this format: https://(host-name):(port)/acs. In this case, you must use your Salesforce login URL. In Salesforce, click Security Controls on your left menu and then click Single Sign-On Settings. In the page that appears, click on the SSO settings that you created to view the details. Use the Salesforce Login URL listed there for this value.
    NameID FormatThe default value can be used here.This defines the name identifier formats supported by the identity provider. The service provider and identity provider usually communicate with each other regarding a specific subject. That subject should be identified through a Name-Identifier (NameID) , which should be in some format so that It is easy for the other party to identify it based on the format. Name identifiers are used to provide information regarding a user.
    Use fully qualified username in the NameIDSelectedA fully qualified username is basically the user name with the user store domain. In short, the username must be in the following format: {user store domain}{user name}.
    Enable Response SigningSelected

    Select Enable Response Signing to sign the SAML2 Responses returned after the authentication process.

    Enable Assertion SigningSelected

    Select Enable Assertion Signing to sign the SAML2 Assertions returned after the authentication. SAML2 relying party components expect these assertions to be signed by the Identity Server.

    Enable Attribute ProfileSelectedSelect Enable Attribute Profile to enable this and add a claim by entering the claim link and clicking the Add Claim button. The Identity Server provides support for a basic attribute profile where the identity provider can include the user’s attributes in the SAML Assertions as part of the attribute statement. Once you select the checkbox to Include Attributes in the Response Always, the identity provider always includes the attribute values related to the selected claims in the SAML attribute statement.
  7. Click Register to save your configurations.
  8. Since Salesforce user names are actually email addresses, we must configure the Identity Server for email authentication. Do the following steps to achieve this.

    1. Open the <IS_HOME>/repository/conf/carbon.xml file and make the following change to the configuration.

      Code Block
      languagexml
      <EnableEmailUserName>true</EnableEmailUserName>
    2. Open the <IS_HOME>/repository/conf/user-mgt.xml file and add the following property under the user store manager configurations. Using above property, you can change the pattern of your email address. By default it must be more than 3 characters and less than 30, but you can configure it as you wish.

      Code Block
      languagexml
      <Property name="UsernameWithEmailJavaScriptRegEx">^[\S]{3,30}$</Property>
  9. Restart the Identity Server.

Testing the configurations

Do the following steps to test out the configurations for a new user in Salesforce and the Identity Server.

  1. On Once you log into the Identity Server, navigate to the Configure tab in the management console, click Users and Roles.
  2. Click Users. This link is only visible to users with the Admin role. 
  3. Click Add New UserWhen adding a new user, use an email address as the username.
  4. Navigate back to the Configure tab in the management console and click Users and Roles.
  5. Click Roles. This link is only visible to users with the Admin role. 
  6. Click Add New Role
    Image Added
    When adding a new role, do the following.
    1. In the Domain list, specify the user store where you want to create this role. In this case, use the default user store that comes with the Identity Server.
    2. Enter a unique name for this role. Use Force here for example.
    3. Click Next.
  7. Select the permissions you want users with this role to have. Note that when you assign this role to a user, you can override the role's permissions and customize them for the user. For our example, providing login permissions should suffice.
    Image Added 
  8. Click Next.
  9. Select the existing users you want to have this role. You can also assign this role to users later, but if you are creating this role in an external user store that does not allow empty roles, you must assign it to at least one user. You can search for a user by name, or view all users by entering * in the search field. In this case, select the user with the username as the email address that you created earlier.
    Image Added 
  10. Click Finish.