Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

!!! note
- This feature can be invoked via a PUT/PATCH request to the SCIM 2.0 /Users endpoint or /Me endpoint.
- The verification on update capability is **only** supported for the `Email` (`http://wso2.org/claims/emailaddress`)

Check failure on line 7 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:7:122 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
and `Verified Email Addresses` (`http://wso2.org/claims/verifiedEmailAddresses`) claims.
- Verification is not triggered if the email address to be updated is the same as a previously verified email address of the user.

## Prerequisites

{% if product_name == "WSO2 Identity Server" %}
- [Configure the email sending module]({{base_path}}/deploy/configure/email-sending-module/) of the {{product_name}}.

Check failure on line 14 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

en/includes/guides/users/attributes/email-verification-on-update.md:14 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [Configure the email sending..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
{% endif %}

- If required, enable [support for multiple email addresses]({{base_path}}/guides/users/attributes/manage-attributes/#assign-multiple-email-addresses-and-mobile-numbers-to-a-user) for users.
Expand Down Expand Up @@ -113,19 +113,19 @@
"userName":"kim"
}
```
Upon receiving the response outlined above, the user will receive an email notification prompting them to verify their

Check failure on line 116 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:116:119 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
updated email address. Once verified, the `Email` claim (`http://wso2.org/claims/emailaddress`) will be updated to

Check failure on line 117 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:117:115 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
reflect the new email address.

!!! note
If you update the primary `Email` claim directly, the change will not be reflected in the `Verified Email Addresses`

Check failure on line 121 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:121:122 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
(`http://wso2.org/claims/verifiedEmailAddresses`) claim after verification.

### Update the verified email addresses list

If you have enabled support for multiple email addresses and mobile numbers, a user can have several verified email addresses and a single primary email address.

To verify an email address,

Check failure on line 128 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:128:28 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md

1. On the {{product_name}} Console, go to **User Management** > **Users**.

Expand Down Expand Up @@ -216,16 +216,67 @@
}
```

Upon receiving the response outlined above, the user will receive an email notification prompting them to verify their

Check failure on line 219 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:219:119 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
updated email address. Once verified, the `verifiedEmailAddresses` claim (http://wso2.org/claims/verifiedEmailAddresses)

Check failure on line 220 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:220:121 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
will be updated to reflect the new email address. {% if product_name == "Asgardeo" or

Check failure on line 221 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:221:86 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
(product_name == "WSO2 Identity Server" and is_version >= "7.2.0")%} If a primary email address has not been configured,

Check failure on line 222 in en/includes/guides/users/attributes/email-verification-on-update.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/includes/guides/users/attributes/email-verification-on-update.md:222:121 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
the verified email address will also be set as the primary email.
{% endif %}

## Resend email verification

Run the following curl command in case you want to resend the email verification.
{% if product_name == "WSO2 Identity Server" %}
### By a non-privileged user

Users can resend the email verification by executing the following API request.
{% endif %}

!!! abstract ""

=== "Request format"

```curl
curl -X POST https://{{ host_name }}/api/identity/user/v1.0/me/resend-code
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json" \
-d '{
"properties": [{
"key":"RecoveryScenario",
"value": <recovery_scenario>
}]
}'
```
=== "Sample request"

```curl
curl -X POST https://{{ host_name_example }}/api/identity/user/v1.0/me/resend-code
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json" \
-d '{
"properties": [{
"key":"RecoveryScenario",
"value":"EMAIL_VERIFICATION_ON_UPDATE"
}]
}'
```
The verification scenario should be specified in the properties parameter of the request body as follows :
```
"properties": [{"key": "RecoveryScenario", "value": "EMAIL_VERIFICATION_ON_UPDATE"}]
```
- `EMAIL_VERIFICATION_ON_UPDATE`: Used when verifying a newly updated email address for a user. </br>
- `EMAIL_VERIFICATION_ON_VERIFIED_LIST_UPDATE`: Used when updating the list of verified email addresses for a
user.
---

**Response**
```curl
HTTP/1.1 201 Created
```

{% if product_name == "WSO2 Identity Server" %}
### By a privileged user

Privileged users can resend the email verification on behalf of a user by executing the following API request.

!!! abstract ""

Expand All @@ -248,8 +299,8 @@
```
=== "Sample request"

```
curl -X POST https://{{ host_name_example }}/api/identity/user/v1.0/resend-code
```curl
curl -X POST https://{{ host_name_example }}/api/identity/user/v1.0/resend-code
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json" \
-d '{
Expand All @@ -268,12 +319,16 @@
"properties": [{"key": "RecoveryScenario", "value": "EMAIL_VERIFICATION_ON_UPDATE"}]
```
- `EMAIL_VERIFICATION_ON_UPDATE`: Used when verifying a newly updated email address for a user. </br>
- `EMAIL_VERIFICATION_ON_VERIFIED_LIST_UPDATE`: Used when updating the list of verified email addresses for a
- `EMAIL_VERIFICATION_ON_VERIFIED_LIST_UPDATE`: Used when updating the list of verified email addresses for a
user.
---

**Response**
```curl
HTTP/1.1 201 Created
```
{% if is_version >= "7.2.0" %}
For more details, see the [Verification Code Management API]({{base_path}}/apis/verification-code-management-rest-api/).
{% endif %}
{% endif %}

Original file line number Diff line number Diff line change
Expand Up @@ -400,4 +400,7 @@ Privileged users can resend an SMS OTP on behalf of a user using the following A
```
"HTTP/1.1 201 Created"
```
{% if is_version >= "7.2.0" %}
For more details, see the [Verification Code Management API]({{base_path}}/apis/verification-code-management-rest-api/).
{% endif %}
{% endif %}
Loading