Get Customer Addresses for Provider - Cloud Security API

{"type":"api","title":"Get Customer Addresses for Provider","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/77649db0-b5f6-3157-b85b-a889624baad4","info":{"title":"Cisco Umbrella Providers API","version":"2.0.0","description":"Manage the customers for a provider.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Providers"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/admin/providers-overview.md","uri":"umbrella-api-reference-providers-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"admin.customers:read":"Read admin customers","admin.customers:write":"Write admin customers","admin.customerSearch:read":"Read admin customer search","admin.customerDeals:read":"Read admin customer deals","admin.customerDeals:write":"Write admin customer deals"}}}}}},"spec":{"tags":["Providers","Umbrella"],"description":"Get the customer addresses for provider.","summary":"Get Customer Addresses for Provider","operationId":"getCustomerAddresses","security":[{"oauthFlow":["admin.customerSearch:read"]}],"parameters":[{"name":"page","in":"query","description":"A number of a page in the collection.","schema":{"type":"integer","default":1,"format":"int32","minimum":1},"required":false,"example":2,"$$ref":"#/components/parameters/pageParam"},{"name":"limit","in":"query","description":"The number of records to return from the collection on a page.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"example":50,"$$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The customer's address information.","required":["accountId","accountSiteId","mappedCrPartyId"],"properties":{"accountId":{"type":"integer","description":"The ID of the account.","example":4590},"accountSiteId":{"type":"integer","description":"The ID of the site for the account.","example":12},"mappedCrPartyId":{"type":"integer","description":"The ID of the mapped CR party.","example":123457},"organizationName":{"type":"string","description":"The name of the customer's organization.","example":"Cisco Systems"},"streetAddress":{"type":"string","description":"The street address for the customer.","minLength":1,"maxLength":255,"example":"One Penn Plaza","$$ref":"#/components/schemas/streetAddress"},"streetAddress2":{"type":"string","description":"The second street address for the customer.","minLength":1,"maxLength":255,"example":"Two Center Way","$$ref":"#/components/schemas/streetAddress2"},"city":{"type":"string","description":"The name of the city where the customer's organization is located.","minLength":1,"maxLength":255,"example":"Culver City","$$ref":"#/components/schemas/city"},"state":{"type":"string","description":"The name of the customer's state.","minLength":1,"maxLength":50,"example":"NY","$$ref":"#/components/schemas/state"},"countryCode":{"type":"string","description":"The country code of the customer's organization.","minLength":2,"maxLength":3,"example":"FR","$$ref":"#/components/schemas/countryCode"},"zipCode":{"type":"string","description":"The zip code of the customer's organization.","minLength":1,"example":"08105","$$ref":"#/components/schemas/zipCode"}},"example":{"accountId":132405632,"accountSiteId":104571945,"mappedCrPartyId":10803658,"organizationName":"cisco","streetAddress":"73 Rue De La Plaine","streetAddress2":"213 Circle Ct","city":"San Jose","state":"CA","countryCode":"US","zipCode":"75020"},"$$ref":"#/components/schemas/CustomerAddress"}},"example":[{"accountId":132405632,"accountSiteId":104571945,"mappedCrPartyId":10803658,"organizationName":"cisco","streetAddress":"73 Rue De La Plain","streetAddress2":"213 Circle Ct","city":"San Jose","state":"CA","countryCode":"US","zipCode":"75020"}]}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Invalid request","properties":{"message":{"type":"string","description":"Message for Invalid request"}}},"example":{"message":"Invalid request"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Unauthorized request","properties":{"message":{"type":"string","description":"Message for Unauthorized request"}}},"example":{"message":"Unauthorized request"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Forbidden","properties":{"message":{"type":"string","description":"Message for Forbidden"}}},"example":{"message":"Forbidden"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Not Found","properties":{"message":{"type":"string","description":"Message for Not Found"}}},"example":{"message":"Not Found"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Server error","properties":{"message":{"type":"string","description":"Message for Server error"}}},"example":{"message":"server error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getCustomerAddresses","method":"get","path":"/providers/customerAddresses"}}