Provider

Provider #

Package : spaceone.api.identity.v2



Provider #

Provider Methods:

MethodRequestResponse
createCreateProviderRequestProviderInfo
updateUpdateProviderRequestProviderInfo
update_pluginUpdatePluginProviderRequestProviderInfo
deleteProviderRequestEmpty
getProviderRequestProviderInfo
listProviderSearchQueryProvidersInfo
statProviderStatQueryStruct

create #

POST /identity/v2/provider/create

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)

{
 "provider": "aws",
 "name": "AWS",
 "alias": "AWS",
 "color": "#FF9900",
 "icon": "https://cloudforet.io/icons/aws.svg",
 "order": 1,
 "options": {
      "supported_trusted_account": false
 }
}

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

{
 "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"
}

update #

POST /identity/v2/provider/update

UpdateProviderRequest

  • provider (string) Required

  • name (string)

  • alias (string)

  • plugin_info (PluginInfo)

  • color (string)

  • icon (string)

  • order (int32)

  • options (Struct)

  • tags (Struct)

{
 "provider": "aws",
 "name": "AWS",
 "alias": "AWS",
 "color": "#FF9900",
 "icon": "https://cloudforet.io/icons/aws.svg",
 "order": 2,
 "options": {
      "supported_trusted_account": false
 }
}

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

{
 "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"
}

update_plugin #

POST /identity/v2/provider/update-plugin

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)

{
 "provider": "aws",
 "version": "1.0.0",
 "options": {},
 "upgrade_mode": "AUTO"
}

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

{
 "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"
}

delete #

POST /identity/v2/provider/delete

ProviderRequest

  • provider (string) Required
{
 "provider": "aws"
}

get #

POST /identity/v2/provider/get

ProviderRequest

  • provider (string) Required
{
 "provider": "aws"
}

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

{
 "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"
}

list #

POST /identity/v2/provider/list

ProviderSearchQuery

  • query (Query)

  • provider (string)

  • name (string)

  • alias (string)

  • is_managed (bool)

{
 "query": {
   "page": {
     "start": 1,
     "limit": 10
   },
   "sort": [
     {
       "key": "created_at",
       "desc": true
     }
   ]
 }
}

ProvidersInfo

  • results (ProviderInfo) Repeated Required

  • total_count (int32) Required

{
 "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
}

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)


Calendar December 3, 2024
Edit Edit this page

Documentation Distributed under CC BY 4.0

Copyright © Cloudforet a Series of LF Projects, LLC. For website terms of use, trademark policy and other project policies please see https://lfprojects.org.