Provider
Last updated
Last updated
Package : spaceone.api.identity.v2
Provider Methods:
POST /identity/v2/provider/create
{{< tabs " create " >}}
{{< tab "Request Example" >}}
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" >}}
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 >}}
POST /identity/v2/provider/update
{{< tabs " update " >}}
{{< tab "Request Example" >}}
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" >}}
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 >}}
POST /identity/v2/provider/update-plugin
{{< tabs " update_plugin " >}}
{{< tab "Request Example" >}}
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" >}}
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 >}}
POST /identity/v2/provider/delete
{{< tabs " delete " >}}
{{< tab "Request Example" >}}
provider (string) Required
{{< highlight json >}} { "provider": "aws" } {{< /highlight >}} {{< /tab >}}
{{< /tabs >}}
POST /identity/v2/provider/get
{{< tabs " get " >}}
{{< tab "Request Example" >}}
provider (string) Required
{{< highlight json >}} { "provider": "aws" } {{< /highlight >}} {{< /tab >}}
{{< tab "Response Example" >}}
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 >}}
POST /identity/v2/provider/list
{{< tabs " list " >}}
{{< tab "Request Example" >}}
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" >}}
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 >}}
POST /identity/v2/provider/stat
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)
plugin_id (string) Required
version (string) Required
upgrade_mode (UpgradeMode) Required
options (Struct) Required
metadata (Struct) Required
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
provider (string) Required
query (Query)
provider (string)
name (string)
alias (string)
is_managed (bool)
query (StatisticsQuery) Required
results (ProviderInfo) Repeated Required
total_count (int32) Required
provider (string) Required
Managed provider are aws, azure, google_cloud and kubernetes. Maybe more in the future.
version (string)
options (Struct)
upgrade_mode (UpgradeMode)
provider (string) Required
name (string)
alias (string)
plugin_info (PluginInfo)
color (string)
icon (string)
order (int32)
options (Struct)
tags (Struct)