-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CI] markdown files has been generated
- Loading branch information
1 parent
e9cfcf9
commit 5d4487c
Showing
2 changed files
with
111 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ bookFlatSection: true | |
| Method | Request | Response | | ||
| :----- | :-------- | :-------- | | ||
| [**update**](./UserProfile#update) | [UpdateUserProfileRequest](UserProfile#updateuserprofilerequest) | [UserInfo](UserProfile#userinfo) | | ||
| [**set_refresh_timeout**](./UserProfile#set_refresh_timeout) | [SetRefreshTimeout](UserProfile#setrefreshtimeout) | [UserInfo](UserProfile#userinfo) | | ||
| [**verify_email**](./UserProfile#verify_email) | [VerifyEmailRequest](UserProfile#verifyemailrequest) | [Empty](UserProfile#empty) | | ||
| [**confirm_email**](./UserProfile#confirm_email) | [ConfirmEmailRequest](UserProfile#confirmemailrequest) | [UserInfo](UserProfile#userinfo) | | ||
| [**reset_password**](./UserProfile#reset_password) | [UserPasswordResetRequest](UserProfile#userpasswordresetrequest) | [Empty](UserProfile#empty) | | ||
|
@@ -55,6 +56,49 @@ bookFlatSection: true | |
|
||
|
||
|
||
<br> | ||
|
||
### set_refresh_timeout | ||
|
||
Sets the user's refresh token timeout. This API can only be used by users with the `DOMAIN_ADMIN` role. | ||
Min value is `1800` seconds and max value is `2592000` seconds | ||
|
||
|
||
|
||
> **POST** /identity/v2/user-profile/set-refresh-timeout | ||
> | ||
|
||
|
||
|
||
|
||
{{< tabs " set_refresh_timeout " >}} | ||
|
||
{{< tab "Request Example" >}} | ||
|
||
|
||
|
||
[SetRefreshTimeout](./UserProfile#setrefreshtimeout) | ||
|
||
* **refresh_timeout** (int32) `Required` | ||
|
||
|
||
|
||
|
||
|
||
{{< highlight json >}} | ||
{ | ||
"refresh_token_timout": 604800 | ||
} | ||
{{< /highlight >}} | ||
{{< /tab >}} | ||
|
||
|
||
|
||
{{< /tabs >}} | ||
|
||
|
||
|
||
<br> | ||
|
||
### verify_email | ||
|
@@ -70,6 +114,31 @@ bookFlatSection: true | |
|
||
|
||
|
||
{{< tabs " verify_email " >}} | ||
|
||
{{< tab "Request Example" >}} | ||
|
||
|
||
|
||
[VerifyEmailRequest](./UserProfile#verifyemailrequest) | ||
|
||
* **email** (string) | ||
|
||
|
||
|
||
|
||
|
||
{{< highlight json >}} | ||
{ | ||
"email": "[email protected]" | ||
} | ||
{{< /highlight >}} | ||
{{< /tab >}} | ||
|
||
|
||
|
||
{{< /tabs >}} | ||
|
||
|
||
|
||
<br> | ||
|
@@ -87,6 +156,31 @@ bookFlatSection: true | |
|
||
|
||
|
||
{{< tabs " confirm_email " >}} | ||
|
||
{{< tab "Request Example" >}} | ||
|
||
|
||
|
||
[ConfirmEmailRequest](./UserProfile#confirmemailrequest) | ||
|
||
* **verify_code** (string) `Required` | ||
|
||
|
||
|
||
|
||
|
||
{{< highlight json >}} | ||
{ | ||
"verify_code": "12346" | ||
} | ||
{{< /highlight >}} | ||
{{< /tab >}} | ||
|
||
|
||
|
||
{{< /tabs >}} | ||
|
||
|
||
|
||
<br> | ||
|
@@ -422,6 +516,11 @@ Confirm MFA for user by given verify_code which is sent by your authentication m | |
|
||
<br> | ||
|
||
### SetRefreshTimeout | ||
* **refresh_timeout** (int32) `Required` | ||
|
||
<br> | ||
|
||
### UpdateUserProfileRequest | ||
* **password** (string) | ||
|
||
|