# Auth

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

## Auth

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

| NO | Method            | Request Type                    | Response Type                     | Description |
| -- | ----------------- | ------------------------------- | --------------------------------- | ----------- |
| 1  | [verify](#verify) | [VerifyRequest](#verifyrequest) | [AuthVerifyInfo](#authverifyinfo) |             |
| 2  | [find](#find)     | [FindRequest](#findrequest)     | [UsersInfo](#usersinfo)           |             |
| 3  | [login](#login)   | [LoginRequest](#loginrequest)   | [UserInfo](#userinfo)             |             |

### verify

| Type     | Message                           |
| -------- | --------------------------------- |
| Request  | [VerifyRequest](#verifyrequest)   |
| Response | [AuthVerifyInfo](#authverifyinfo) |

### find

| Type     | Message                     |
| -------- | --------------------------- |
| Request  | [FindRequest](#findrequest) |
| Response | [UsersInfo](#usersinfo)     |

### login

| Type     | Message                       |
| -------- | ----------------------------- |
| Request  | [LoginRequest](#loginrequest) |
| Response | [UserInfo](#userinfo)         |

## Message

### AuthVerifyInfo

| No | Field   | Type                                                                                                               | Required | Description |
| -- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
| 1  | options | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          |             |

### FindRequest

| No | Field        | Type                                                                                                               | Required | Description |
| -- | ------------ | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
| 1  | options      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          | required    |
| 2  | secret\_data | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          | required    |
| 3  | user\_id     | string                                                                                                             |          | optional    |
| 4  | keyword      | string                                                                                                             |          | optional    |

### LoginRequest

| No | Field             | Type                                                                                                               | Required | Description |
| -- | ----------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
| 1  | options           | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          | required    |
| 2  | secret\_data      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          | required    |
| 3  | user\_credentials | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          | required    |

### UserInfo

| No | Field    | Type                                                                                              | Required | Description |
| -- | -------- | ------------------------------------------------------------------------------------------------- | -------- | ----------- |
| 1  | user\_id | string                                                                                            |          |             |
| 2  | name     | string                                                                                            |          |             |
| 3  | email    | string                                                                                            |          |             |
| 4  | mobile   | string                                                                                            |          |             |
| 5  | group    | string                                                                                            |          |             |
| 6  | state    | <p>UserInfo.State</p><ul><li>NONE</li><li>ENABLED</li><li>DISABLED</li><li>UNIDENTIFIED</li></ul> |          |             |

### UsersInfo

| No | Field        | Type                                                                                            | Required | Description |
| -- | ------------ | ----------------------------------------------------------------------------------------------- | -------- | ----------- |
| 1  | results      | [UserInfo](#userinfo)                                                                           |          |             |
| 2  | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |          |             |

### VerifyRequest

| No | Field        | Type                                                                                                               | Required | Description |
| -- | ------------ | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
| 1  | options      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          | required    |
| 2  | secret\_data | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |          | required    |
