# Provider

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

\
\


## Provider

**Provider Methods:**

| Method                                                                                                                             | Request                                                                                                                                                   | Response                                                                                                                      |
| ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#create)                | [CreateProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#createproviderrequest)             | [ProviderInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#update)                | [UpdateProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#updateproviderrequest)             | [ProviderInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerinfo)   |
| [**update\_plugin**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#update_plugin) | [UpdatePluginProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#updatepluginproviderrequest) | [ProviderInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#delete)                | [ProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerrequest)                         | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#empty)                 |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#get)                      | [ProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerrequest)                         | [ProviderInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#list)                    | [ProviderSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providersearchquery)                 | [ProvidersInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providersinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#stat)                    | [ProviderStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerstatquery)                     | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#struct)               |

\


### create

> **POST** /identity/v2/provider/create

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

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

[CreateProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#createproviderrequest)

* **provider** (string) `Required`
* **name** (string) `Required`
* **alias** (string)
*   **plugin\_info** (PluginInfo)

    _If plugin\_info is not empty, your provider support trusted account and support auto sync for Cloudforet. These two options are located in options field. not in plugin\_info._
* **color** (string)
* **icon** (string)
* **order** (int32)
* **options** (Struct)
* **tags** (Struct)

\{{< highlight json >\}} { "provider": "aws", "name": "AWS", "alias": "AWS", "color": "#FF9900", "icon": "https://cloudforet.io/icons/aws.svg", "order": 1, "options": { "supported\_trusted\_account": false } } \{{< /highlight >\}} \{{< /tab >\}}

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

[ProviderInfo](#PROVIDERINFO)

* **provider** (string) `Required`
* **name** (string) `Required`
* **alias** (string) `Required`
* **plugin\_info** (PluginInfo) `Required`
* **color** (string) `Required`
* **icon** (string) `Required`
* **order** (int32) `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "alias": "AWS", "created\_at": "2024-11-15T04:47:42.393Z", "domain\_id": "domain-a1b2c3d4e5f6", "icon": "https://cloudforet.io/icons/aws.svg", "name": "AWS", "options": { "supported\_trusted\_account": false }, "order": 1, "provider": "aws", "updated\_at": "2024-11-15T04:47:42.393Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update

> **POST** /identity/v2/provider/update

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

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

[UpdateProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#updateproviderrequest)

* **provider** (string) `Required`
* **name** (string)
* **alias** (string)
* **plugin\_info** (PluginInfo)
* **color** (string)
* **icon** (string)
* **order** (int32)
* **options** (Struct)
* **tags** (Struct)

\{{< highlight json >\}} { "provider": "aws", "name": "AWS", "alias": "AWS", "color": "#FF9900", "icon": "https://cloudforet.io/icons/aws.svg", "order": 2, "options": { "supported\_trusted\_account": false } } \{{< /highlight >\}} \{{< /tab >\}}

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

[ProviderInfo](#PROVIDERINFO)

* **provider** (string) `Required`
* **name** (string) `Required`
* **alias** (string) `Required`
* **plugin\_info** (PluginInfo) `Required`
* **color** (string) `Required`
* **icon** (string) `Required`
* **order** (int32) `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "alias": "AWS", "created\_at": "2024-11-15T04:47:42.393Z", "domain\_id": "domain-a1b2c3d4e5f6", "icon": "https://cloudforet.io/icons/aws.svg", "name": "AWS", "options": { "supported\_trusted\_account": false }, "order": 1, "provider": "aws", "updated\_at": "2024-11-15T04:47:42.393Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update\_plugin

> **POST** /identity/v2/provider/update-plugin

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

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

[UpdatePluginProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#updatepluginproviderrequest)

*   **provider** (string) `Required`

    _Managed provider are aws, azure, google\_cloud and kubernetes. Maybe more in the future._
* **version** (string)
* **options** (Struct)
* **upgrade\_mode** (UpgradeMode)

\{{< highlight json >\}} { "provider": "aws", "version": "1.0.0", "options": {}, "upgrade\_mode": "AUTO" } \{{< /highlight >\}} \{{< /tab >\}}

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

[ProviderInfo](#PROVIDERINFO)

* **provider** (string) `Required`
* **name** (string) `Required`
* **alias** (string) `Required`
* **plugin\_info** (PluginInfo) `Required`
* **color** (string) `Required`
* **icon** (string) `Required`
* **order** (int32) `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "alias": "AWS", "created\_at": "2024-11-15T04:47:42.393Z", "domain\_id": "domain-a1b2c3d4e5f6", "icon": "https://cloudforet.io/icons/aws.svg", "name": "AWS", "options": { "supported\_trusted\_account": false }, "order": 1, "provider": "aws", "updated\_at": "2024-11-15T04:47:42.393Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### delete

> **POST** /identity/v2/provider/delete

\{{< tabs " delete " >\}}

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

[ProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerrequest)

* **provider** (string) `Required`

\{{< highlight json >\}} { "provider": "aws" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### get

> **POST** /identity/v2/provider/get

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

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

[ProviderRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providerrequest)

* **provider** (string) `Required`

\{{< highlight json >\}} { "provider": "aws" } \{{< /highlight >\}} \{{< /tab >\}}

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

[ProviderInfo](#PROVIDERINFO)

* **provider** (string) `Required`
* **name** (string) `Required`
* **alias** (string) `Required`
* **plugin\_info** (PluginInfo) `Required`
* **color** (string) `Required`
* **icon** (string) `Required`
* **order** (int32) `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "alias": "AWS", "created\_at": "2024-11-15T04:47:42.393Z", "domain\_id": "domain-a1b2c3d4e5f6", "icon": "https://cloudforet.io/icons/aws.svg", "name": "AWS", "options": { "supported\_trusted\_account": false }, "order": 1, "provider": "aws", "updated\_at": "2024-11-15T04:47:42.393Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### list

> **POST** /identity/v2/provider/list

\{{< tabs " list " >\}}

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

[ProviderSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/identity/v2/Provider/README.md#providersearchquery)

* **query** (Query)
* **provider** (string)
* **name** (string)
* **alias** (string)
* **is\_managed** (bool)

\{{< highlight json >\}} { "query": { "page": { "start": 1, "limit": 10 }, "sort": \[ { "key": "created\_at", "desc": true } ] } } \{{< /highlight >\}} \{{< /tab >\}}

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

[ProvidersInfo](#PROVIDERSINFO)

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

\{{< highlight json >\}} { "results": \[ { "alias": "Azure", "created\_at": "2024-11-15T04:47:42.393Z", "domain\_id": "domain-a1b2c3d4e5f6", "icon": "https://cloudforet.io/icons/azure.svg", "name": "Azure", "options": { "supported\_trusted\_account": false }, "order": 1, "provider": "azure", "updated\_at": "2024-11-15T04:47:42.393Z" }, { "alias": "AWS", "created\_at": "2024-11-15T04:47:42.393Z", "domain\_id": "domain-a1b2c3d4e5f6", "icon": "https://cloudforet.io/icons/aws.svg", "name": "AWS", "options": { "supported\_trusted\_account": false }, "order": 1, "provider": "aws", "updated\_at": "2024-11-15T04:47:42.393Z" } ], "total\_count": 2 } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### stat

> **POST** /identity/v2/provider/stat

\
\


## Message

### CreateProviderRequest

* **provider** (string) `Required`
* **name** (string) `Required`
* **alias** (string)
*   **plugin\_info** (PluginInfo)

    _If plugin\_info is not empty, your provider support trusted account and support auto sync for Cloudforet. These two options are located in options field. not in plugin\_info._
* **color** (string)
* **icon** (string)
* **order** (int32)
* **options** (Struct)
*   **tags** (Struct)

    \


### PluginInfo

* **plugin\_id** (string) `Required`
* **version** (string) `Required`
* **upgrade\_mode** (UpgradeMode) `Required`
* **options** (Struct) `Required`
*   **metadata** (Struct) `Required`

    \


### ProviderInfo

* **provider** (string) `Required`
* **name** (string) `Required`
* **alias** (string) `Required`
* **plugin\_info** (PluginInfo) `Required`
* **color** (string) `Required`
* **icon** (string) `Required`
* **order** (int32) `Required`
* **options** (Struct) `Required`
* **tags** (Struct) `Required`
* **is\_managed** (bool) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
*   **updated\_at** (string) `Required`

    \


### ProviderRequest

*   **provider** (string) `Required`

    \


### ProviderSearchQuery

* **query** (Query)
* **provider** (string)
* **name** (string)
* **alias** (string)
*   **is\_managed** (bool)

    \


### ProviderStatQuery

*   **query** (StatisticsQuery) `Required`

    \


### ProvidersInfo

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

    \


### UpdatePluginProviderRequest

*   **provider** (string) `Required`

    _Managed provider are aws, azure, google\_cloud and kubernetes. Maybe more in the future._
* **version** (string)
* **options** (Struct)
*   **upgrade\_mode** (UpgradeMode)

    \


### UpdateProviderRequest

* **provider** (string) `Required`
* **name** (string)
* **alias** (string)
* **plugin\_info** (PluginInfo)
* **color** (string)
* **icon** (string)
* **order** (int32)
* **options** (Struct)
*   **tags** (Struct)

    \
