# Auth

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

## Auth

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

| Method                | Request                         | Response                                                                                                         |
| --------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| [**init**](#init)     | [InitRequest](#initrequest)     | [PluginInfo](#plugininfo)                                                                                        |
| [**verify**](#verify) | [VerifyRequest](#verifyrequest) | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |
| [**find**](#find)     | [FindRequest](#findrequest)     | [UsersInfo](#usersinfo)                                                                                          |
| [**login**](#login)   | [LoginRequest](#loginrequest)   | [UserInfo](#userinfo)                                                                                            |

### init

| Type     | Message                     |
| -------- | --------------------------- |
| Request  | [InitRequest](#initrequest) |
| Response | [PluginInfo](#plugininfo)   |

### verify

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [VerifyRequest](#verifyrequest)                                                                                  |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### find

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

### login

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

##

## Message

### AuthVerifyInfo

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

### FindRequest

| Field        | Type                                                                                                               | Required | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| options      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| secret\_data | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| user\_id     | string                                                                                                             |     ✘    |             |
| keyword      | string                                                                                                             |     ✘    |             |
| schema       | string                                                                                                             |     ✘    |             |

### InitRequest

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

### LoginRequest

| Field             | Type                                                                                                               | Required | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| options           | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| secret\_data      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| user\_credentials | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| schema            | string                                                                                                             |     ✘    |             |

### PluginInfo

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

### UserInfo

| Field    | Type                                                                         | Description |
| -------- | ---------------------------------------------------------------------------- | ----------- |
| user\_id | string                                                                       |             |
| name     | string                                                                       |             |
| email    | string                                                                       |             |
| mobile   | string                                                                       |             |
| group    | string                                                                       |             |
| state    | <ul><li>NONE</li><li>ENABLED</li><li>DISABLED</li><li>UNIDENTIFIED</li></ul> |             |

### UsersInfo

| Field        | Type                                                                                            | Description |
| ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| results      | [list of UserInfo](#userinfo)                                                                   |             |
| total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |
| more         | bool                                                                                            |             |

### VerifyRequest

| Field        | Type                                                                                                               | Required | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| options      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| secret\_data | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| schema       | string                                                                                                             |     ✘    |             |