> For the complete documentation index, see [llms.txt](https://spaceone-dev.gitbook.io/spaceone-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spaceone-dev.gitbook.io/spaceone-apis/v1.6.2-rc11/identity/v1/user.md).

# User

User API which allows member management within project, company, and domain

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

## User

{% hint style="info" %}
**User Methods:**
{% endhint %}

| NO | Method                                                                | Request Type                                                                          | Response Type                                                                                                      | Description                        |
| -- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------- |
| 1  | [**create**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#create)   | [CreateUserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#createuserrequest) | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                                                |                                    |
| 2  | [**update**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#update)   | [UpdateUserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#updateuserrequest) | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                                                | Update user info by given user\_id |
| 3  | [**enable**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#enable)   | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest)             | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                                                |                                    |
| 4  | [**disable**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#disable) | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest)             | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                                                |                                    |
| 5  | [**delete**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#delete)   | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |                                    |
| 6  | [**get**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#get)         | [GetUserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#getuserrequest)       | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                                                |                                    |
| 7  | [**list**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#list)       | [UserQuery](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userquery)                 | [UsersInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#usersinfo)                                              |                                    |
| 8  | [**stat**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#stat)       | [UserStatQuery](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userstatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |                                    |
| 9  | [**find**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#find)       | [FindUserQuery](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#finduserquery)         | [FindUsersInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#findusersinfo)                                      |                                    |
| 10 | [**sync**](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#sync)       | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest)             | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                                                |                                    |

### create

> **POST** /identity/v1/users

| Type     | Message                                                                               |
| -------- | ------------------------------------------------------------------------------------- |
| Request  | [CreateUserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#createuserrequest) |
| Response | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                   |

### update

> **PUT** /identity/v1/users
>
> Update user info by given user\_id

| Type     | Message                                                                               |
| -------- | ------------------------------------------------------------------------------------- |
| Request  | [UpdateUserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#updateuserrequest) |
| Response | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                   |

{% tabs %}
{% tab title="Request Example" %}

```
{
    "user_id": "dkang@mz.co.kr",
    "tags": [
        {
            "key": "user1",
            "value": "Reuters"
        },
        {
            "key": "user2",
            "value": "Bloomberg"
        }
    ],
    "domain_id": "{{DOMAIN_ID}}"
}
```

{% endtab %}

{% tab title="Response Example" %}

```
{
    "user_id": "dkang@mz.co.kr",
    "name": "Dong Yoo kang",
    "state": "ENABLED",
    "email": "dkang@mz.co.kr",
    "language": "en",
    "timezone": "UTC",
    "tags": [
        {
            "key": "user1",
            "value": "Reuters"
        },
        {
            "key": "user2",
            "value": "Bloomberg"
        }
    ],
    "last_accessed_at": {
        "seconds": "1593161630",
        "nanos": 79000000
    },
    "created_at": {
        "seconds": "1593161630",
        "nanos": 79000000
    },
    "domain_id": "domain-fd6e23a5ae36"
}
```

{% endtab %}
{% endtabs %}

### enable

> **PUT** /identity/v1/user/{user\_id}/enable

| Type     | Message                                                                   |
| -------- | ------------------------------------------------------------------------- |
| Request  | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest) |
| Response | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)       |

### disable

> **PUT** /identity/v1/user/{user\_id}/disable

| Type     | Message                                                                   |
| -------- | ------------------------------------------------------------------------- |
| Request  | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest) |
| Response | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)       |

### delete

> **DELETE** /identity/v1/users

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest)                                        |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### get

> **GET** /identity/v1/user/{user\_id}

| Type     | Message                                                                         |
| -------- | ------------------------------------------------------------------------------- |
| Request  | [GetUserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#getuserrequest) |
| Response | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)             |

### list

> **GET** /identity/v1/users
>
> **POST** /identity/v1/users/search

| Type     | Message                                                               |
| -------- | --------------------------------------------------------------------- |
| Request  | [UserQuery](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userquery) |
| Response | [UsersInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#usersinfo) |

### stat

> **POST** /identity/v1/users/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [UserStatQuery](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userstatquery)                                      |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### find

> **POST** /identity/v1/users/find

| Type     | Message                                                                       |
| -------- | ----------------------------------------------------------------------------- |
| Request  | [FindUserQuery](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#finduserquery) |
| Response | [FindUsersInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#findusersinfo) |

### sync

> **POST** /identity/v1/users/sync

| Type     | Message                                                                   |
| -------- | ------------------------------------------------------------------------- |
| Request  | [UserRequest](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userrequest) |
| Response | [UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)       |

## Message

### CreateUserRequest

| No | Field      | Type                                                              | Required | Description |
| -- | ---------- | ----------------------------------------------------------------- | -------- | ----------- |
| 1  | user\_id   | string                                                            | ✅        |             |
| 2  | password   | string                                                            | ❌        |             |
| 3  | name       | string                                                            | ❌        |             |
| 4  | email      | string                                                            | ❌        |             |
| 5  | user\_type | <ul><li>NONE\_USER\_TYPE</li><li>USER</li><li>API\_USER</li></ul> | ❌        |             |
| 6  | backend    | <ul><li>NONE\_BACKEND</li><li>LOCAL</li><li>EXTERNAL</li></ul>    | ✅        |             |
| 7  | language   | string                                                            | ❌        |             |
| 8  | timezone   | string                                                            | ❌        |             |
| 9  | tags       | list of spaceone.api.core.v1.Tag                                  | ❌        |             |
| 10 | domain\_id | string                                                            | ✅        |             |

### FindUserInfo

| No | Field    | Type                             | Description |
| -- | -------- | -------------------------------- | ----------- |
| 1  | user\_id | string                           |             |
| 2  | name     | string                           |             |
| 3  | email    | string                           |             |
| 4  | tags     | list of spaceone.api.core.v1.Tag |             |

### FindUserQuery

| No | Field      | Type                                                                            | Required | Description |
| -- | ---------- | ------------------------------------------------------------------------------- | -------- | ----------- |
| 1  | search     | [FindUserSearch](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#findusersearch) | ✅        |             |
| 2  | domain\_id | string                                                                          | ✅        |             |

### FindUserSearch

| No | Field    | Type   | Description |
| -- | -------- | ------ | ----------- |
| 1  | user\_id | string |             |
| 2  | keyword  | string |             |

### FindUsersInfo

| No | Field        | Type                                                                                            | Description |
| -- | ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| 1  | results      | [list of FindUserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#finduserinfo)             |             |
| 2  | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |

### GetUserRequest

| No | Field      | Type           | Required | Description |
| -- | ---------- | -------------- | -------- | ----------- |
| 1  | user\_id   | string         | ✅        |             |
| 2  | domain\_id | string         | ✅        |             |
| 3  | only       | list of string | ❌        |             |

### UpdateUserRequest

| No | Field      | Type                             | Required | Description |
| -- | ---------- | -------------------------------- | -------- | ----------- |
| 1  | user\_id   | string                           | ✅        |             |
| 2  | password   | string                           | ❌        |             |
| 3  | name       | string                           | ❌        |             |
| 4  | email      | string                           | ❌        |             |
| 5  | language   | string                           | ❌        |             |
| 6  | timezone   | string                           | ❌        |             |
| 7  | tags       | list of spaceone.api.core.v1.Tag | ❌        |             |
| 8  | domain\_id | string                           | ✅        |             |

### UserInfo

| No | Field              | Type                                                                                                                     | Description |
| -- | ------------------ | ------------------------------------------------------------------------------------------------------------------------ | ----------- |
| 1  | user\_id           | string                                                                                                                   |             |
| 2  | name               | string                                                                                                                   |             |
| 3  | state              | <ul><li>NONE</li><li>ENABLED</li><li>DISABLED</li><li>PENDING</li></ul>                                                  |             |
| 4  | email              | string                                                                                                                   |             |
| 5  | user\_type         | <ul><li>NONE\_USER\_TYPE</li><li>USER</li><li>API\_USER</li></ul>                                                        |             |
| 6  | backend            | <ul><li>NONE\_BACKEND</li><li>LOCAL</li><li>EXTERNAL</li></ul>                                                           |             |
| 7  | language           | string                                                                                                                   |             |
| 8  | timezone           | string                                                                                                                   |             |
| 9  | tags               | list of spaceone.api.core.v1.Tag                                                                                         |             |
| 10 | last\_accessed\_at | [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto) |             |
| 11 | created\_at        | [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto) |             |
| 12 | domain\_id         | string                                                                                                                   |             |

### UserQuery

| No | Field      | Type                                                                                               | Required | Description |
| -- | ---------- | -------------------------------------------------------------------------------------------------- | -------- | ----------- |
| 1  | query      | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | ❌        |             |
| 2  | user\_id   | string                                                                                             | ❌        |             |
| 3  | name       | string                                                                                             | ❌        |             |
| 4  | state      | string                                                                                             | ❌        |             |
| 5  | email      | string                                                                                             | ❌        |             |
| 6  | user\_type | <ul><li>NONE\_USER\_TYPE</li><li>USER</li><li>API\_USER</li></ul>                                  | ❌        |             |
| 7  | backend    | <ul><li>NONE\_BACKEND</li><li>LOCAL</li><li>EXTERNAL</li></ul>                                     | ❌        |             |
| 8  | domain\_id | string                                                                                             | ❌        |             |

### UserRequest

| No | Field      | Type   | Required | Description |
| -- | ---------- | ------ | -------- | ----------- |
| 1  | user\_id   | string | ✅        |             |
| 2  | domain\_id | string | ✅        |             |

### UserStatQuery

| No | Field      | Type                                                                                                             | Required | Description |
| -- | ---------- | ---------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
| 1  | query      | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) | ✅        |             |
| 2  | domain\_id | string                                                                                                           | ✅        |             |

### UsersInfo

| No | Field        | Type                                                                                            | Description |
| -- | ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| 1  | results      | [list of UserInfo](/spaceone-apis/v1.6.2-rc11/identity/v1/user.md#userinfo)                     |             |
| 2  | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |