{"type":"api","title":"Get Provider Credentials By Account Id","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get provider credentials by account id","operationId":"getProviderCredentialsByAccountId","parameters":[{"name":"accountId","in":"path","description":"Service User Account ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"providerAccountDetailsList":{"type":"array","items":{"required":["accountId","accountUserName","apiKey","carrierName","isDefault"],"type":"object","properties":{"acceptTermsAndConditions":{"type":"boolean","description":"Boolean value which indicates if the account user accepts account provider's terms and conditions if they exist."},"accountData":{"required":["apn","authMethod","commPlan","pdnType","ratePlan"],"type":"object","properties":{"apn":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Access Point Name","example":"103334b644"},"authMethod":{"maxLength":2147483647,"minLength":1,"pattern":"(^none$|^pap$|^chap$|^pap_or_chap$)","type":"string","description":"Authentication method.","example":"pap"},"commPlan":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the communication plan associated with default provider.","example":"vm cp sms data shared"},"password":{"type":"string","description":"Password of the user.","example":"admin123"},"pdnType":{"maxLength":2147483647,"minLength":1,"pattern":"(^IPv4$|^IPv6$|^IPv4v6$)","type":"string","description":"Data packet protocol version","example":"IPv4"},"ratePlan":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the rate plan associated with default provider.","example":"vm fixed pool rp"},"user":{"type":"string","description":"User name.","example":"admin"}},"$$ref":"#/components/schemas/AccountData"},"accountId":{"type":"string","description":" ID of the account associated with user using provider service.","example":"100025578"},"accountUserName":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the user registered to the service.","example":"JaneDoe"},"apiKey":{"maxLength":2147483647,"minLength":1,"type":"string","description":"API key for the provider service.","example":"1d6fa2f9-5a7d-4af8-8ab5-4056f631"},"carrierName":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the service provider.","example":"Singtel"},"isDefault":{"type":"boolean","description":"Boolean value which indicates whether the provider is the default provider ."}},"$$ref":"#/components/schemas/ProviderAccountDetails"}}},"$$ref":"#/components/schemas/ProviderAccountDetailsList"},"examples":{"Service Provider Credentials Response Example":{"description":"Service Provider Credentials Response Example","value":"{\n\t \"carrierName\": \"Singtel\",\n\t \"accountId\": \"100023372\",\n\t \"accountUserName\":\"testaa\" ,\n\t \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n\t \"isDefault\":true,\n\t \"acceptTermsAndConditions\":true,\n\t \"accountData\":{\n\t \"ratePlan\": \"vm fixed pool rp\",\n\t \"commPlan\": \"vm cp sms data shared\",\n\t \"apn\": \"123456789\",\n\t \"pdnType\": \"IPv4\",\n\t \"authType\": \"pap\",\n\t \"user\": \"admin\",\n\t \"password\": \"admin123\"\n\t }"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read","__originalOperationId":"getProviderCredentialsByAccountId","method":"get","path":"/v1/securedeviceonboarding/{accountId}/providercredentials"}}