Validate Account Add - Cisco Catalyst SD-WAN Manager API, Release 20.18 - Cisco DevNet

{"type":"api","title":"Validate Account Add","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["MultiCloud - Accounts"],"description":"Add Cloud Account","operationId":"validateAccountAdd","requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"required":["accountName","azureCredentials","cloudType","gcpCredentials"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"maxLength":255,"minLength":1,"type":"string"},"awsIamCredentials":{"required":["externalId","roleArn"],"type":"object","properties":{"externalId":{"type":"string"},"roleArn":{"type":"string"}},"$$ref":"#/components/schemas/AwsIamCredentials"},"awsKeyCredentials":{"required":["apiKey","secretKey"],"type":"object","properties":{"apiKey":{"type":"string"},"secretKey":{"type":"string"}},"$$ref":"#/components/schemas/AwsKeyCredentials"},"azureCredentials":{"required":["clientId","cloudTenantId","secretKey","subscriptionId"],"type":"object","properties":{"clientId":{"type":"string"},"cloudTenantId":{"type":"string"},"secretKey":{"type":"string"},"subscriptionId":{"type":"string"}},"$$ref":"#/components/schemas/AzureCredentials"},"cloudGatewayEnabled":{"pattern":"^(true|false)$","type":"string"},"cloudType":{"type":"string"},"description":{"maxLength":1024,"minLength":0,"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"gcpBillingId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]+$","type":"string"},"gcpCredentials":{"required":["auth_provider_x509_cert_url","auth_uri","client_email","client_id","client_x509_cert_url","private_key","private_key_id","project_id","token_uri","type"],"type":"object","properties":{"auth_provider_x509_cert_url":{"type":"string"},"auth_uri":{"type":"string"},"client_email":{"type":"string"},"client_id":{"type":"string"},"client_x509_cert_url":{"type":"string"},"private_key":{"type":"string"},"private_key_id":{"type":"string"},"project_id":{"type":"string"},"token_uri":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/GcpCredentials"},"kubernetesDiscoveryEnabled":{"pattern":"^(true|false)$","type":"string"},"serviceDiscoveryEnabled":{"pattern":"^(true|false)$","type":"string"}},"$$ref":"#/components/schemas/PostAccounts"},"examples":{"GCP Add Account request":{"description":"GCP Add Account request","value":[{"accountName":"pp-gcp","cloudGatewayEnabled":true,"cloudType":"GCP","description":"pp-test","gcpCredentials":{"value":{"auth_provider_x509_cert_url":"https://www.googleapis.com/test","auth_uri":"https://accounts.google.com/test","client_email":"gcp-pp@gcp.com","client_id":"1234","client_x509_cert_url":"https://www.googleapis.com/test","private_key":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCw7wLu5GWUYwV5\nA/NFvjXpz8fz2NpF2eBjC+6rLO4qxjxzXcZUGwsAFwzwT52n4D0WpLlSJNZOCtcSkK5beoPXUdPBd\nSTwn7uIrt5459tdsdfYkOIc=\n-----END PRIVATE KEY-----","private_key_id":"45678","project_id":"gcp-ppp-21471","token_uri":"https://oauth2.googleapis.com/test","type":"service_account"}},"serviceDiscoveryEnabled":false}]},"AWS Iam/AWS Iam GovCloud Add Account request":{"description":"AWS Iam/AWS Iam GovCloud Add Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsIamCredentials":{"roleArn":"arn101","externalId":"ext101"}}]},"AWS key/AWS key GovCloud Add Account request":{"description":"AWS key/AWS key GovCloud Add Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsKeyCredentials":{"apiKey":"key102","secretKey":"skey102"},"cloudGatewayEnabled":"true"}]},"Azure/Azure GovCloud Add Account request":{"description":"Azure/Azure GovCloud Add Account request","value":[{"cloudType":"AZURE","accountName":"azure_acct_102","description":"azure_acct_102 desc","azureCredentials":{"subscriptionId":"sub103","secretKey":"skey103","clientId":"clientid103","cloudTenantId":"clienttenant103"},"cloudGatewayEnabled":"true","azO365Enabled":"true"}]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"regionList":{"type":"string"}},"$$ref":"#/components/schemas/PostAccountsResponse"},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"post","path":"/multicloud/accounts"}}