> 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/identity/v1/provider.md).

# Provider

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

## Provider

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

| Method                | Request                                         | Response                                                                                                           |
| --------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**create**](#create) | [CreateProviderRequest](#createproviderrequest) | [ProviderInfo](#providerinfo)                                                                                      |
| [**update**](#update) | [UpdateProviderRequest](#updateproviderrequest) | [ProviderInfo](#providerinfo)                                                                                      |
| [**delete**](#delete) | [ProviderRequest](#providerrequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**get**](#get)       | [GetProviderRequest](#getproviderrequest)       | [ProviderInfo](#providerinfo)                                                                                      |
| [**list**](#list)     | [ProviderQuery](#providerquery)                 | [ProvidersInfo](#providersinfo)                                                                                    |
| [**stat**](#stat)     | [ProviderStatQuery](#providerstatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### create

> **POST** /identity/v1/providers

| Type     | Message                                         |
| -------- | ----------------------------------------------- |
| Request  | [CreateProviderRequest](#createproviderrequest) |
| Response | [ProviderInfo](#providerinfo)                   |

### update

> **PUT** /identity/v1/provider/{provider\_id}

| Type     | Message                                         |
| -------- | ----------------------------------------------- |
| Request  | [UpdateProviderRequest](#updateproviderrequest) |
| Response | [ProviderInfo](#providerinfo)                   |

### delete

> **DELETE** /identity/v1/provider/{provider\_id}

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

### get

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

| Type     | Message                                   |
| -------- | ----------------------------------------- |
| Request  | [GetProviderRequest](#getproviderrequest) |
| Response | [ProviderInfo](#providerinfo)             |

### list

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

| Type     | Message                         |
| -------- | ------------------------------- |
| Request  | [ProviderQuery](#providerquery) |
| Response | [ProvidersInfo](#providersinfo) |

### stat

> **POST** /identity/v1/providers/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [ProviderStatQuery](#providerstatquery)                                                                            |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

##

## Message

### CreateProviderRequest

| Field      | Type                                                                                                               | Required | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| provider   | string                                                                                                             |     ✔    |             |
| name       | string                                                                                                             |     ✔    |             |
| template   | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| metadata   | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| capability | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| tags       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| domain\_id | string                                                                                                             |     ✔    |             |

### GetProviderRequest

| Field      | Type           | Required | Description |
| ---------- | -------------- | :------: | ----------- |
| provider   | string         |     ✔    |             |
| only       | list of string |     ✘    |             |
| domain\_id | string         |     ✔    |             |

### ProviderInfo

| Field       | Type                                                                                                               | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| provider    | string                                                                                                             |             |
| name        | string                                                                                                             |             |
| template    | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| metadata    | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| capability  | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| tags        | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| created\_at | string                                                                                                             |             |

### ProviderQuery

| Field      | Type                                                                                               | Required | Description |
| ---------- | -------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query      | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) |     ✘    |             |
| provider   | string                                                                                             |     ✘    |             |
| name       | string                                                                                             |     ✘    |             |
| domain\_id | string                                                                                             |     ✔    |             |

### ProviderRequest

| Field      | Type   | Required | Description |
| ---------- | ------ | :------: | ----------- |
| provider   | string |     ✔    |             |
| domain\_id | string |     ✔    |             |

### ProviderStatQuery

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

### ProvidersInfo

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

### UpdateProviderRequest

| Field      | Type                                                                                                               | Required | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| provider   | string                                                                                                             |     ✔    |             |
| name       | string                                                                                                             |     ✘    |             |
| template   | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| metadata   | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| capability | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| tags       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| domain\_id | string                                                                                                             |     ✔    |             |