openapi: 3.2.0 info: title: Others Secure Device OnBoarding - Provider Credentials API description: 'Other APIs Include APIs that do not belong to other categories' 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: 26.1.0+2026-01-06 x-provenance: method: harvested authored_by: Cisco Catalyst SD-WAN harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host. x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/ - type: source url: https://developer.cisco.com/docs/sdwan/ servers: - url: /dataservice tags: - name: Secure Device OnBoarding - Provider Credentials paths: /v1/securedeviceonboarding/providercredentials: post: tags: - Secure Device OnBoarding - Provider Credentials description: Create service provider credentials operationId: createProviderCredentials requestBody: description: Create Provider Credentials content: application/json: schema: type: object examples: Service Provider Credentials: description: Service Provider Credentials value: carrierName: Singtel accountId: '100023372' accountUserName: testaa apiKey: d6fa2f9-5a7d-4af8-8ab5-4056f631 isDefault: false acceptTermsAndConditions: true required: true responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Secure Device Onboarding-write /v1/securedeviceonboarding/providerscredentials: get: tags: - Secure Device OnBoarding - Provider Credentials description: Get all providers credentials operationId: getAllAccounts responses: '200': description: Success content: application/json: schema: 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' examples: Service Providers Credentials Response Example: description: Service Providers Credentials Response Example value: - carrierName: Singtel accountId: '100023372' accountUserName: testaa apiKey: d6fa2f9-5a7d-4af8-8ab5-4056f631 isDefault: false acceptTermsAndConditions: true '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Secure Device Onboarding-read /v1/securedeviceonboarding/registeredproviders: get: tags: - Secure Device OnBoarding - Provider Credentials description: Get Registered Providers Info operationId: getProvidersInfo responses: '200': description: Success content: application/json: schema: type: object properties: cmpType: type: string cmpUrl: type: string contactInfoLine1: type: string contactInfoLine2: type: string contactInfoLine3: type: string countryCode: type: string operatorLogoUrl: type: string operatorName: type: string termsAndConditions: type: string $$ref: '#/components/schemas/ProviderInfo' examples: Registered Providers Response Example: description: Registered Providers Response Example value: '[{"operatorName":"SingTel Test","countryCode":"+1","cmpUrl":"https://rws-jpotest.i.jasperwireless.com","cmpType":"CC"," + ""contactInfoLine1":"3003 Bunker Hill lane ","contactInfoLine2":"$$$$$$$$$","contactInfoLine3":"asdfv!!!!6578","operatorLogoUrl":"https://jpotest.jasper.com/provision/logout","termsAndConditions":"Do you accept our terms 1, If yes press Ok or Sorry you cannot use our service ,See you next time!!"}]' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Secure Device Onboarding-read /v1/securedeviceonboarding/{accountId}/providerCredentials: delete: tags: - Secure Device OnBoarding - Provider Credentials description: Delete provider credentials operationId: deleteProviderCredentials parameters: - name: accountId in: path description: Service User Account Id required: true schema: type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Secure Device Onboarding-write /v1/securedeviceonboarding/{accountId}/providercredentials: get: 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 \"carrierName\": \"Singtel\",\n \"accountId\": \"100023372\",\n \"accountUserName\":\"testaa\" ,\n \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n \"isDefault\":true,\n \"acceptTermsAndConditions\":true,\n \"accountData\":{\n \"ratePlan\": \"vm fixed pool rp\",\n \"commPlan\": \"vm cp sms data shared\",\n \"apn\": \"123456789\",\n \"pdnType\": \"IPv4\",\n \"authType\": \"pap\",\n \"user\": \"admin\",\n \"password\": \"admin123\"\n }" '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Secure Device Onboarding-read put: tags: - Secure Device OnBoarding - Provider Credentials description: Edit service provider credentials operationId: editProviderCredentials parameters: - name: accountId in: path description: Service User Account ID required: true schema: type: string requestBody: description: Provider Credentials content: application/json: schema: 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' examples: Update Provider Credentials: description: Update Provider Credentials value: "{\n \"carrierName\": \"Singtel\",\n \"accountId\": \"100023372\",\n \"accountUserName\":\"testaa\" ,\n \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n \"isDefault\":true,\n \"acceptTermsAndConditions\":true,\n \"accountData\":{\n \"ratePlan\": \"vm fixed pool rp\",\n \"commPlan\": \"vm cp sms data shared\",\n \"apn\": \"123456789\",\n \"pdnType\": \"IPv4\",\n \"authType\": \"pap\",\n \"user\": \"admin\",\n \"password\": \"admin123\"\n }" required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Secure Device Onboarding-write /v1/securedeviceonboarding/{deviceUUID}/deviceusage: get: tags: - Secure Device OnBoarding - Provider Credentials description: Get device data usage using device uuid operationId: getDeviceDataUsage parameters: - name: deviceUUID in: path description: DeviceUUID required: true schema: type: string responses: '200': description: Success content: application/json: schema: required: - carrierName - communicationPlan - controllerId - currentDataUsage - iccid - ratePlan - ratePlanType - slotId type: object properties: carrierName: type: string description: Name of the service provider. example: Singtel communicationPlan: type: string description: Name of the communication plan. example: vm cp sms data share controllerId: type: string description: Controller Id example: '1' currentDataUsage: type: string description: Current Data Usage. example: 10MB errorDetails: type: string description: Details of any error encountered while retrieving device data usage example: No eSIM ICCIDs found esimStatus: type: string description: Bootstrap eSim Status example: ACTIVATED iccid: type: string description: Identifier of the eSIM device. example: '8988216716970004975' isBootstrap: type: boolean description: Boolean flag that indicated if ICCID is on bootstrap account otherEsimsDataUsage: type: string description: Total data used by other eSIM devices. example: 20MB ratePlan: type: string description: Name of the rate plan. example: vm fixed pool rp ratePlanDataUsageLimit: type: string description: Rate plan usage limit. example: 50MB ratePlanType: type: string description: Rate plan type. example: Monthly - Pooled Subscriber slotId: type: integer description: Slot Id format: int32 totalDataUsage: type: string description: Total data usage example: 30MB usageThresholdWarning: type: array description: Total value of current data usage and data used by other eSIM devices example: Data Usage has reached or exceeded the threshold limit of 90%. items: type: string description: Total value of current data usage and data used by other eSIM devices example: Data Usage has reached or exceeded the threshold limit of 90%. $$ref: '#/components/schemas/DeviceUsageDetails' examples: Device Usage Response Example: description: Device Usage Response Example value: "[{\n \"iccid\": \"8988216716970004975\",\n \"carrierName\": \"Singtel\",\n \"ratePlan\":\"hphlr rp1\" ,\n \"communicationPlan\": \"vm cp sms data shared\",\n \"ratePlanType\":\"Monthly - Pooled Subscriber\",\n \"currentDataUsage\":\"10MB\",\n \"ratePlanUsageLimit\": \"50MB\",\n \"otherEsimsDataUsage\": \"20MB\",\n }]" '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Secure Device Onboarding-read