Create Customer Security Report Request - Cloud Security API

{"type":"api","title":"Create Customer Security Report Request","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/820fcafe-b182-32fa-a453-9975f795ce70","info":{"title":"Providers Console Report","version":"2.0.0","description":"Providers Console Report","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Providers"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/providers-consoles-overview.md","uri":"umbrella-api-reference-providers-consoles-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"reports.customers:read":"Read reports customers","reports.customers:write":"Write reports customers"}}}}}},"spec":{"tags":["Providers","Umbrella"],"description":"Create security report request for customer of service provider.","summary":"Create Customer Security Report Request","operationId":"createCustomerSecurityReportRequest","security":[{"oauthFlow":["reports.customers:write"]}],"parameters":[{"name":"customerId","description":"The customer ID","schema":{"type":"integer"},"in":"path","required":true,"$$ref":"#/components/parameters/customerIdParam"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["status","data"],"properties":{"data":{"type":"object","description":"The data for the request to access the report","properties":{"id":{"type":"integer","description":"The ID of the request to generate the report"},"header":{"type":"object","description":"The status information about the report","properties":{"date":{"type":"integer","description":"The date of the generated report specified in milliseconds"},"status":{"type":"string","description":"The status of the report generation"}}},"body":{"type":"object","description":"The details of the report","properties":{"email":{"type":"string","format":"email","description":"The email address used to send the report"},"end_date":{"type":"string","format":"date","description":"The report includes data that appears before the specified date","example":"2022-07-13"},"organization_id":{"type":"string","description":"The ID of the customer's organization"},"organization_name":{"type":"string","description":"The name of the customer's organization"},"origin_id":{"type":"string","description":"The origin ID"},"start_date":{"type":"string","format":"date","description":"The report includes data that appears after the specified date","example":"2022-06-13"}}}}},"status":{"type":"string","description":"The status of the report generation request"},"task":{"type":"string","description":"The task for the report generation"}},"example":{"data":{"body":{"email":"user@cisco.com","end_date":"2022-09-09","organization_id":"7970851","organization_name":"Abc Prime Product","origin_id":"585256703","start_date":"2022-09-01"},"header":{"date":1663674125,"status":"pending"},"id":2683},"status":"ok","task":"enqueue-task"},"$$ref":"#/components/schemas/SecurityReportsRequest"},"example":{"data":{"body":{"email":"user@cisco.com","end_date":"2022-09-09","organization_id":"7970851","organization_name":"Abc Prime Product","origin_id":"585256703","start_date":"2022-09-01"},"header":{"date":1663674125,"status":"pending"},"id":2683},"status":"ok","task":"enqueue-task"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Validation Error","type":"object","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}},"$$ref":"#/components/schemas/BadRequestError"}}},"$$ref":"#/components/responses/InvalidRequest"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"description":"Unauthorized- The authorization header is missing or the token is unauthorized","type":"object","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Unauthorized","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"description":"Forbidden- The token is invalid","type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden, Invalid authentication credentials","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/ForbiddenError"}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Not Found- A resource specified in the URL was not found","type":"object","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/NotFoundError"}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Error- This request could not be processed by the server","type":"object","properties":{"statusCode":{"type":"integer","example":500,"description":"the http error code returned"},"error":{"type":"string","example":"Internal Server Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}},"$$ref":"#/components/schemas/ServerError"}}},"$$ref":"#/components/responses/ServerErr"}},"__originalOperationId":"createCustomerSecurityReportRequest","method":"post","path":"/providers/customers/{customerId}/securityReportRequests"}}