Skip to content

Commit

Permalink
[CI] markdown files has been generated
Browse files Browse the repository at this point in the history
  • Loading branch information
admin-cloudforet committed Oct 31, 2024
1 parent e9cfcf9 commit 5d4487c
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 9 deletions.
21 changes: 12 additions & 9 deletions content/en/identity/v2/User.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ note: Administrator must register User first.
| :----- | :-------- | :-------- |
| [**create**](./User#create) | [CreateUserRequest](User#createuserrequest) | [UserInfo](User#userinfo) |
| [**update**](./User#update) | [UpdateUserRequest](User#updateuserrequest) | [UserInfo](User#userinfo) |
| [**verify_email**](./User#verify_email) | [VerifyUserEmailRequest](User#verifyuseremailrequest) | [Empty](User#empty) |
| [**disable_mfa**](./User#disable_mfa) | [DisableUserMFARequest](User#disableusermfarequest) | [UserInfo](User#userinfo) |
| [**set_required_actions**](./User#set_required_actions) | [SetRequiredActionsRequest](User#setrequiredactionsrequest) | [UserInfo](User#userinfo) |
| [**verify_email**](./User#verify_email) | [VerifyEmailUserRequest](User#verifyemailuserrequest) | [Empty](User#empty) |
| [**disable_mfa**](./User#disable_mfa) | [DisableMFAUserRequest](User#disablemfauserrequest) | [UserInfo](User#userinfo) |
| [**set_required_actions**](./User#set_required_actions) | [SetRequiredActionsUserRequest](User#setrequiredactionsuserrequest) | [UserInfo](User#userinfo) |
| [**enable**](./User#enable) | [UserRequest](User#userrequest) | [UserInfo](User#userinfo) |
| [**disable**](./User#disable) | [UserRequest](User#userrequest) | [UserInfo](User#userinfo) |
| [**delete**](./User#delete) | [UserRequest](User#userrequest) | [Empty](User#empty) |
Expand Down Expand Up @@ -160,7 +160,7 @@ Update user info by given user_id



[VerifyUserEmailRequest](./User#verifyuseremailrequest)
[VerifyEmailUserRequest](./User#verifyemailuserrequest)

* **user_id** (string) `Required`

Expand Down Expand Up @@ -206,7 +206,7 @@ Disable MFA for user. If this api is called, send email to user.



[DisableUserMFARequest](./User#disableusermfarequest)
[DisableMFAUserRequest](./User#disablemfauserrequest)

* **user_id** (string) `Required`

Expand Down Expand Up @@ -248,7 +248,7 @@ Disable MFA for user. If this api is called, send email to user.



[SetRequiredActionsRequest](./User#setrequiredactionsrequest)
[SetRequiredActionsUserRequest](./User#setrequiredactionsuserrequest)

* **user_id** (string) `Required`

Expand Down Expand Up @@ -521,7 +521,7 @@ Disable MFA for user. If this api is called, send email to user.

<br>

### DisableUserMFARequest
### DisableMFAUserRequest
* **user_id** (string) `Required`

<br>
Expand All @@ -537,7 +537,7 @@ Disable MFA for user. If this api is called, send email to user.

<br>

### SetRequiredActionsRequest
### SetRequiredActionsUserRequest
* **user_id** (string) `Required`


Expand Down Expand Up @@ -608,6 +608,9 @@ Disable MFA for user. If this api is called, send email to user.
* **required_actions** (UserRequiredAction) `Repeated` `Required`


* **refresh_timeout** (int32) `Required`


* **tags** (Struct) `Required`


Expand Down Expand Up @@ -659,7 +662,7 @@ Disable MFA for user. If this api is called, send email to user.

<br>

### VerifyUserEmailRequest
### VerifyEmailUserRequest
* **user_id** (string) `Required`


Expand Down
99 changes: 99 additions & 0 deletions content/en/identity/v2/UserProfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down Expand Up @@ -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
Expand All @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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)

Expand Down

0 comments on commit 5d4487c

Please sign in to comment.