Get Customer Trial Strength - Cloud Security API

{"type":"api","title":"Get Customer Trial Strength","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/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 strength of a customer trial for a provider.","summary":"Get Customer Trial Strength","operationId":"getCustomerTrialStrength","security":[{"oauthFlow":["admin.customers:read"]}],"parameters":[{"name":"customerId","in":"path","description":"The ID of the customer.","required":true,"schema":{"type":"integer","format":"int32"},"$$ref":"#/components/parameters/customerIdParam"}],"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":"object","description":"The number of features consumed by a customer trial.","required":["customerLoggedIn","lastLoginDate","identitiesCreated","hasTraffic","trialStrength"],"properties":{"customerLoggedIn":{"type":"boolean","description":"Specify whether the trial customer logged into their organization.","example":true},"lastLoginDate":{"type":"string","format":"iso-date-time","description":"The date when the customer last logged into their organization.","example":"2022-10-03 13:42:39"},"identitiesCreated":{"type":"integer","description":"The number of identities that were created.","example":25},"hasTraffic":{"type":"boolean","description":"Specify whether the organization has traffic.","example":false},"trialStrength":{"type":"string","description":"The number of features used by the trial.\nThe hyphen (`-`) character indicates no features.","enum":["Low","Medium","High","-"],"example":"-"}},"example":{"customerLoggedIn":true,"lastLoginDate":"2022-10-03 13:42:39","identitiesCreated":12,"hasTraffic":false,"trialStrength":"-"},"$$ref":"#/components/schemas/TrialStrength"},"example":{"customerLoggedIn":true,"lastLoginDate":"2022-10-03 13:42:39","identitiesCreated":25,"hasTraffic":false,"trialStrength":"-"}}}},"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":"getCustomerTrialStrength","method":"get","path":"/providers/customers/{customerId}/trialStrengths"}}