# User

User API which allows member management within project, company, and domain note: Administrator must register User first.

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

\
\


## User

**User Methods:**

| Method                                                                                                                                        | Request                                                                                                                                           | Response                                                                                                                  |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#create)                               | [CreateUserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#createuserrequest)                 | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#update)                               | [UpdateUserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#updateuserrequest)                 | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**verify\_email**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#verify_email)                  | [VerifyEmailRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#verifyemailrequest)               | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#empty)                 |
| [**confirm\_email**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#confirm_email)                | [ConfirmEmailRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#confirmemailrequest)             | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**reset\_password**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#reset_password)              | [UserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userrequest)                             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#empty)                 |
| [**set\_required\_actions**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#set_required_actions) | [SetRequiredActionsRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#setrequiredactionsrequest) | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**enable\_mfa**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#enable_mfa)                      | [EnableMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#enablemfarequest)                   | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**disable\_mfa**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#disable_mfa)                    | [DisableMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#disablemfarequest)                 | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**confirm\_mfa**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#confirm_mfa)                    | [ConfirmMFARequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#confirmmfarequest)                 | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**enable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#enable)                               | [UserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userrequest)                             | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**disable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#disable)                             | [UserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userrequest)                             | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#delete)                               | [UserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userrequest)                             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#empty)                 |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#get)                                     | [GetUserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#getuserrequest)                       | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#list)                                   | [UserQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userquery)                                 | [UsersInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#usersinfo)         |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#stat)                                   | [UserStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userstatquery)                         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#struct)               |
| [**find**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#find)                                   | [FindUserQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#finduserquery)                         | [FindUsersInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#findusersinfo) |
| [**sync**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#sync)                                   | [UserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userrequest)                             | [UserInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#userinfo)           |

\


### create

You can create user. after create user you have to binding role to user. See role-binding create api. External type user do not need password.

> **POST** /identity/v1/user/create

\{{< tabs " create " >\}}

\{{< tab "Request Example" >\}}

[CreateUserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#createuserrequest)

* **user\_id** (string) `Required`
* **backend** (UserBackend) `Required`
* **domain\_id** (string) `Required`
*   **password** (string)

    _When backend is LOCAL, password is required._
* **name** (string)
* **email** (string)
* **user\_type** (UserType)
*   **language** (string)

    _en,ko_
*   **timezone** (string)

    _UTC, Asia/Seoul_
* **tags** (Struct)
*   **reset\_password** (bool)

    _If reset\_password is true, send email_

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "password": "password", "name": "Wonny", "email": "example@cloudforet.com", "user\_type": "USER", "backend": "LOCAL", "language": "en", "timezone": "UTC", "tags": { "Department": "Development" } } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update

Update user info by given user\_id

> **POST** /identity/v1/user/update

\{{< tabs " update " >\}}

\{{< tab "Request Example" >\}}

[UpdateUserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v1/User/README.md#updateuserrequest)

* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **password** (string)
* **name** (string)
* **email** (string)
* **language** (string)
* **timezone** (string)
* **tags** (Struct)
* **reset\_password** (bool)

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "tags": { "Department": "Development", "Role" }, "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### verify\_email

> **POST** /identity/v1/user/verify-email

\


### confirm\_email

> **POST** /identity/v1/user/confirm-email

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

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### reset\_password

+noauth

> **POST** /identity/v1/user/reset-password

\


### set\_required\_actions

> **POST** /identity/v1/user/set-required-actions

\{{< tabs " set\_required\_actions " >\}}

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### enable\_mfa

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

> **POST** /identity/v1/user/enable-mfa

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

\{{< tab "Request Example" >\}}

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

* **user\_id** (string) `Required`
*   **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._
* **domain\_id** (string) `Required`

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

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### disable\_mfa

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

> **POST** /identity/v1/user/disable-mfa

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

\{{< tab "Request Example" >\}}

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

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

    _If this value true, disable MFA without verification for user._

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

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### confirm\_mfa

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

> **POST** /identity/v1/user/confirm-mfa

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

\{{< tab "Request Example" >\}}

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

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

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

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### enable

> **POST** /identity/v1/user/enable

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

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### disable

> **POST** /identity/v1/user/disable

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

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### delete

> **POST** /identity/v1/user/delete

\


### get

> **POST** /identity/v1/user/get

\{{< tabs " get " >\}}

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### list

> **POST** /identity/v1/user/list

\


### stat

> **POST** /identity/v1/user/stat

\


### find

> **POST** /identity/v1/user/find

\


### sync

> **POST** /identity/v1/user/sync

\{{< tabs " sync " >\}}

\{{< tab "Response Example" >\}}

[UserInfo](#USERINFO)

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
* **mfa** (MFA) `Required`

\{{< highlight json >\}} { "user\_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email\_verified" : true, "mfa": { "mfa\_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last\_accessed\_at": "2023-01-01T07:12:41.890Z" "created\_at": "2023-01-01T15:23:31.705Z" "domain\_id": "domain-xxxxxxxxxxxx" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\
\


## Message

### ConfirmEmailRequest

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

    \


### ConfirmMFARequest

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

    \


### CreateUserRequest

* **user\_id** (string) `Required`
* **backend** (UserBackend) `Required`
* **domain\_id** (string) `Required`
*   **password** (string)

    _When backend is LOCAL, password is required._
* **name** (string)
* **email** (string)
* **user\_type** (UserType)
*   **language** (string)

    _en,ko_
*   **timezone** (string)

    _UTC, Asia/Seoul_
* **tags** (Struct)
*   **reset\_password** (bool)

    _If reset\_password is true, send email_

    \


### DisableMFARequest

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

    _If this value true, disable MFA without verification for user._

    \


### EnableMFARequest

* **user\_id** (string) `Required`
*   **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._
*   **domain\_id** (string) `Required`

    \


### FindUserInfo

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **email** (string) `Required`
*   **tags** (Struct) `Required`

    \


### FindUserQuery

* **search** (FindUserSearch) `Required`
*   **domain\_id** (string) `Required`

    \


### FindUserSearch

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

    \


### FindUsersInfo

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

    \


### GetUserRequest

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

    \


### MFA

* **state** (MFAState) `Required`
* **mfa\_type** (string) `Required`
*   **options** (Struct) `Required`

    \


### SetRequiredActionsRequest

* **user\_id** (string) `Required`
* **actions** (UserRequiredAction) `Repeated` `Required`
*   **domain\_id** (string) `Required`

    \


### UpdateUserRequest

* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **password** (string)
* **name** (string)
* **email** (string)
* **language** (string)
* **timezone** (string)
* **tags** (Struct)
*   **reset\_password** (bool)

    \


### UserInfo

* **user\_id** (string) `Required`
* **name** (string) `Required`
* **state** (State) `Required`
* **email** (string) `Required`
* **user\_type** (UserType) `Required`
* **backend** (UserBackend) `Required`
* **language** (string) `Required`
* **timezone** (string) `Required`
* **required\_actions** (UserRequiredAction) `Repeated` `Required`
* **tags** (Struct) `Required`
* **last\_accessed\_at** (string) `Required`
* **created\_at** (string) `Required`
* **domain\_id** (string) `Required`
* **email\_verified** (bool) `Required`
*   **mfa** (MFA) `Required`

    \


### UserQuery

* **query** (Query)
* **user\_id** (string)
* **name** (string)
* **state** (string)
* **email** (string)
* **user\_type** (UserType)
* **backend** (UserBackend)
*   **domain\_id** (string)

    \


### UserRequest

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

    \


### UserStatQuery

* **query** (StatisticsQuery) `Required`
*   **domain\_id** (string) `Required`

    \


### UsersInfo

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

    \


### VerifyEmailRequest

* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **email** (string)
*   **force** (bool)

    \
