Invite new users¶

This section is about the user on-boarding flows initiated by administrators from an invitation to the user's email which allow respective end users to decide their own passwords or verify the accounts created by administrators.

Set up notifications¶

• Enable the email sending configurations of the WSO2 Identity Server.

  Tip

  The email template used to send this email notification is the AskPassword template.

  You can edit and customize the email template. For more information on how to do this, see Customizing Automated Emails.

• If you have migrated from a previous IS version, ensure that the IdentityMgtEventListener with the orderId=50 is set to false and that the Identity Listeners with orderId=95 and orderId=97 are set to true in the <IS_HOME>/repository/conf/deployment.toml file.

  Note

  If there are no such entries for event.default_listener.xxx in deployment.toml, you can skip this configuration.

  [event.default_listener.identity_mgt]
  priority= "50"
  enable = false
  [event.default_listener.governance_identity_mgt]
  priority= "95"
  enable = true
  [event.default_listener.governance_identity_store]
  priority= "97"
  enable = true

Enable the invitation flow¶

Use the management console¶

[identity_mgt.user_onboarding]
ask_password_from_user= true

1. Log in to the Management Console (https://<IS_HOST>:<PORT>/carbon).

2. Click Resident under Identity Providers on Main > Identity and expand the User Onboarding tab.

3. Expand Ask Password and configure the Ask password code expiry time field.

4. Also, select Enable User Email Verification. Click Update to save changes.

   

Use the configuration file¶

You can also configure the above configurations via the configuration files.

Make sure the following configuration is added to the <IS_HOME>/repository/conf/deployment.toml file to set the confirmation URL valid time period in minutes.
The confirmation link that is provided to the user to set the password is invalid after the time specified here has elapsed.

[identity_mgt.user_onboarding]
enable_email_verification = true
verification_email_validity = "1440"
lock_on_creation=true
ask_password_email_validity = "1440"
password_generator = "org.wso2.carbon.user.mgt.common.DefaultPasswordGenerator"
[identity_mgt] 
email_sender= "internal"

Use the SCIM2 API¶

You can use both the Ask Password and Verify Email features when creating a user using SCIM 2.0.

[identity_mgt.user_onboarding]
disable_random_value_for_credentials= true

• Set the askPassword attribute under theurn:ietf:params:scim:schemas:extension:enterprise:2.0:User schema to true in the SCIM2 user create request.

  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{askPassword:"true"}

  A sample curl command is given below:

  curl -v -k --user admin:admin --data '{"schemas":[],"name":{"familyName":"Smith","givenName":"Paul"},"userName":"Paul","password":"password","emails":[{"primary":true,"value":"[email protected]"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{askPassword:"true"}}'}}' --header "Content-Type:application/json" https://localhost:9443/scim2/Users

• Set the verifyEmail attribute under theurn:ietf:params:scim:schemas:extension:enterprise:2.0:User schema to true in the SCIM2 user create request.

  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{verifyEmail:"true"}

  A sample curl command is given below:

  curl -v -k --user admin:admin --data '{"schemas":[],"name":{"familyName":"Smith","givenName":"Peter"},"userName":"Peter","password":"password","emails":[{"primary":true,"value":"[email protected]"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{verifyEmail:"true"}}'}}' --header "Content-Type:application/json" https://localhost:9443/scim2/Users

Try it out¶

Follow the steps below to test the account creation using the password option.

1. Log in to the WSO2 Identity Server Management Console (https://<IS_HOST>:<PORT>/carbon) using administrator credentials (admin:admin).

2. Navigate to Main > Identity > Users and Roles > Add.

3. Click Add New User.

   

4. Fill in the form:

   1. Select the userstore where you want to create this user account from the drop-down as the Domain.
      This includes the list of userstores you configured. See Configuring userstores for more information.

   2. Enter a unique User Name that is used by the user to log in.

   3. Allow users to enter their own password by selecting the Ask password from user option.

   4. Enter a valid Email Address and click Finish.

      Using special characters in the email address

      If you are using special characters such as $ in your email address, see Configuring Emails with Special Characters.

5. The Identity Server sends an email to the email address provided. The email contains a redirect URL that directs the users to a screen where they must provide their own password.