{"type":"api","title":"Get Providers Console Data","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":"Get the data available from the provider's console.","summary":"Get Providers Console Data","operationId":"getProvidersConsoleData","security":[{"oauthFlow":["reports.customers:read"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"packageName":{"type":"string","description":"The name of the service provider's subscribed package"},"seatsTotal":{"type":"integer","description":"The number of seats allocated to the service provider"},"seatsUsed":{"type":"integer","description":"The number of seats used by the service provider"},"customerCount":{"type":"integer","description":"The number of customers for the service provider"},"status":{"type":"string","description":"The status of the service provider"},"rebillAt":{"type":"string","format":"date-time","description":"The time when the service provider was rebilled.\nThe timestamp is specified in the ISO 8601 format."},"expiresAt":{"type":"string","format":"date-time","description":"The time when the service provider's subscription expires.\nThe timestamp is specified in the ISO 8601 format."}},"required":["packageName","seatsTotal","seatsUsed","customerCount","status","rebillAt","expiresAt"],"example":{"packageName":"Umbrella SIG Essentials","seatsTotal":25,"seatsUsed":20,"customerCount":20,"status":"enrolled","rebillAt":"2022-06-13T16:07:07.222Z","expiresAt":"2022-06-13T16:07:07.222Z"},"$$ref":"#/components/schemas/ProvidersConsole"},"example":{"packageName":"Umbrella SIG Essentials","seatsTotal":25,"seatsUsed":20,"customerCount":20,"status":"enrolled","rebillAt":"2022-06-13T16:07:07.222Z","expiresAt":"2022-06-13T16:07:07.222Z"}}}},"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":"getProvidersConsoleData","method":"get","path":"/providers/consoles"}}