# UserProfile

> **Package : spaceone.api.identity.v2**

\ <br>

## UserProfile

**UserProfile Methods:**

| Method                                                                                                                                               | Request                                                                                                                                                                | Response                                                                                                                                         |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#update)                               | [UpdateUserProfileRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#updateuserprofilerequest)                 | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userinfo)                           |
| [**verify\_email**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#verify_email)                  | [VerifyEmailRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#verifyemailrequest)                             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#empty)                                 |
| [**confirm\_email**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#confirm_email)                | [ConfirmEmailRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#confirmemailrequest)                           | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userinfo)                           |
| [**reset\_password**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#reset_password)              | [UserPasswordResetRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userpasswordresetrequest)                 | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#empty)                                 |
| [**enable\_mfa**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#enable_mfa)                      | [EnableMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#enablemfarequest)                                 | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userinfo)                           |
| [**disable\_mfa**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#disable_mfa)                    | [DisableMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#disablemfarequest)                               | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userinfo)                           |
| [**confirm\_mfa**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#confirm_mfa)                    | [ConfirmMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#confirmmfarequest)                               | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userinfo)                           |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#get)                                     | [UserProfileRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userprofilerequest)                             | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userinfo)                           |
| [**get\_workspaces**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#get_workspaces)              | [UserProfileRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#userprofilerequest)                             | [MyWorkspacesInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#myworkspacesinfo)           |
| [**get\_workspace\_groups**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#get_workspace_groups) | [WorkspaceGroupUserProfileRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#workspacegroupuserprofilerequest) | [MyWorkspaceGroupsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#myworkspacegroupsinfo) |

<br>

### update

> **POST** /identity/v2/user-profile/update

<br>

### verify\_email

> **POST** /identity/v2/user-profile/verify-email

{{< tabs " verify\_email " >}}

{{< tab "Request Example" >}}

[VerifyEmailRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#verifyemailrequest)

* **email** (string)

{{< highlight json >}} { "email": "<wonny@cloudforet.io>" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### confirm\_email

> **POST** /identity/v2/user-profile/confirm-email

{{< tabs " confirm\_email " >}}

{{< tab "Request Example" >}}

[ConfirmEmailRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#confirmemailrequest)

* **verify\_code** (string) `Required`

{{< highlight json >}} { "verify\_code": "12346" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### reset\_password

+noauth

> **POST** /identity/v2/user-profile/reset-password

<br>

### enable\_mfa

Enable MFA for user. If this api is called, send email to user.

> **POST** /identity/v2/user-profile/enable-mfa

{{< tabs " enable\_mfa " >}}

{{< tab "Request Example" >}}

[EnableMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#enablemfarequest)

* **mfa\_type** (string) `Required`

  *EMAIL*
* **options** (Struct) `Required`

  *If mfa\_type is EMAIL, email is required in options. options will be saved in mfa's options field.*

{{< highlight json >}} { "user\_id": "<example@cloudforet.com>", "mfa\_type": "EMAIL", "options": {"email": "<wonny@cloudforet.com>"}, "domain\_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### disable\_mfa

Disable MFA for user. If this api is called, send email to user.

> **POST** /identity/v2/user-profile/disable-mfa

{{< tabs " disable\_mfa " >}}

{{< tab "Request Example" >}}

[DisableMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#disablemfarequest)

{{< highlight json >}} { "user\_id": "<example@cloudforet.com>", "force": false, "domain\_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### confirm\_mfa

Confirm MFA for user by given verify\_code which is sent by your authentication method.

> **POST** /identity/v2/user-profile/confirm-mfa

{{< tabs " confirm\_mfa " >}}

{{< tab "Request Example" >}}

[ConfirmMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/UserProfile/README.md#confirmmfarequest)

* **verify\_code** (string) `Required`

{{< highlight json >}} { "user\_id": "example\@cloudforet", "verify\_code": "123456", "domain\_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

> **POST** /identity/v2/user-profile/get

<br>

### get\_workspaces

> **POST** /identity/v2/user-profile/get-workspaces

<br>

### get\_workspace\_groups

> **POST** /identity/v2/user-profile/get-workspace-groups

\ <br>

## Message

### ConfirmEmailRequest

* **verify\_code** (string) `Required`

  <br>

### ConfirmMFARequest

* **verify\_code** (string) `Required`

  <br>

### DisableMFARequest<br>

### EnableMFARequest

* **mfa\_type** (string) `Required`

  *EMAIL*
* **options** (Struct) `Required`

  *If mfa\_type is EMAIL, email is required in options. options will be saved in mfa's options field.*

  <br>

### MyWorkspaceGroupInfo

* **workspace\_group\_id** (string) `Required`
* **name** (string) `Required`
* **users** (UserWorkspaceGroup) `Repeated` `Required`
* **tags** (Struct) `Required`
* **role\_binding\_info** (RoleBindingInfo) `Required`
* **created\_by** (string) `Required`
* **updated\_by** (string) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

  <br>

### MyWorkspaceGroupsInfo

* **results** (MyWorkspaceGroupInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

  <br>

### MyWorkspaceInfo

* **workspace\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **role\_name** (string) `Required`
* **role\_type** (RoleType) `Required`
* **tags** (Struct) `Required`
* **created\_by** (string) `Required`
* **reference\_id** (string) `Required`
* **is\_managed** (bool) `Required`
* **is\_dormant** (bool) `Required`
* **domain\_id** (string) `Required`
* **role\_id** (string) `Required`
* **created\_at** (string) `Required`
* **last\_synced\_at** (string) `Required`
* **dormant\_updated\_at** (string) `Required`

  <br>

### MyWorkspacesInfo

* **results** (MyWorkspaceInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

  <br>

### UpdateUserProfileRequest

* **password** (string)
* **name** (string)
* **email** (string)
* **language** (string)
* **timezone** (string)
* **tags** (Struct)

  <br>

### UserPasswordResetRequest

* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`

  <br>

### UserProfileRequest

* **workspace\_group\_id** (string)

  <br>

### VerifyEmailRequest

* **email** (string)

  <br>

### WorkspaceGroupUserProfileRequest<br>