Get Logo - Cloud Security API

{"type":"api","title":"Get Logo","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/1c5aeeec-4882-398f-a870-38681aa1c52d","info":{"title":"Cisco Umbrella Service Providers Console API","version":"2.0.0","description":"Configure the Service Providers console.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Cnames"},{"name":"Contacts"},{"name":"Logos"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/admin/service-providers-console-overview.md","uri":"umbrella-api-reference-service-providers-console-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.config:read":"Read admin config","admin.config:write":"Write admin config"}}}}}},"spec":{"tags":["Logos","Umbrella"],"description":"Get a logo for the service providers console.","summary":"Get Logo","operationId":"getLogo","parameters":[{"name":"logoId","in":"path","description":"The logo ID.","schema":{"type":"integer"},"required":true,"example":5315,"$$ref":"#/components/parameters/logoIdParam"}],"security":[{"oauthFlow":["admin.config:read"]}],"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 information about the service provider's logo.","required":["id","organizationId","imageKey","token","enabled","brandingTypeId","imageUrl"],"properties":{"id":{"type":"integer","description":"The ID of the logo.","example":123455},"organizationId":{"type":"string","description":"The ID of the organization associated with the logo.","example":"123456a"},"imageUrl":{"type":"string","format":"url","description":"The URL for the logo.","example":"https://examples.com"},"imageKey":{"type":"string","format":"binary","description":"The key for the logo.","example":"a/9/a91cafcae22469451ddb449a547a508ac8b2b12aee6f0bac336445f971de628c232b042ef812a4138c7eab51b64b0df1af591a5c56d73bae14c3179db9198d12.png"},"token":{"type":"string","minLength":64,"maxLength":64,"description":"The randomly generated number for the logo.","example":"1234567889123456789123456789123456789123456789123456789123456789"},"createdAt":{"type":"integer","format":"int32","description":"The time when the logo was created. The time is specified in milliseconds.","example":1559836800},"modifiedAt":{"type":"integer","format":"int32","description":"The time when the logo was last modified. The time is specified in milliseconds.","example":1559836800},"enabled":{"type":"boolean","default":false,"example":true,"description":"Specify whether the logo is in use."},"brandingTypeId":{"type":"integer","description":"The ID of the type of branding.","example":4}},"example":{"id":1235455,"organizationId":"123456a","imageUrl":"https://examples.com","imageKey":"a/9/a91cafcae22469451ddb449a547a508ac8b2b12aee6f0bac336445f971de628c232b042ef812a4138c7eab51b64b0df1af591a5c56d73bae14c3179db9198d12.png","token":"1234567889123456789123456789123456789123456789123456789123456789","createdAt":1559836800,"modifiedAt":1559836800,"enabled":true,"brandingTypeId":4},"$$ref":"#/components/schemas/Logo"},"example":{"id":1235455,"organizationId":"123456a","imageUrl":"https://examples.com","imageKey":"a/9/a91cafcae22469451ddb449a547a508ac8b2b12aee6f0bac336445f971de628c232b042ef812a4138c7eab51b64b0df1af591a5c56d73bae14c3179db9198d12.png","token":"1234567889123456789123456789123456789123456789123456789123456789","createdAt":1559836800,"modifiedAt":1559836800,"enabled":true,"brandingTypeId":4}}}},"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","properties":{"message":{"type":"string"}}},"example":{"message":"Bad 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","properties":{"message":{"type":"string"}}},"example":{"message":"Unauthorized"}}},"$$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","properties":{"message":{"type":"string"}}},"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","properties":{"message":{"type":"string"}}},"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","properties":{"message":{"type":"string"}}},"example":{"message":"Internal Server Error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getLogo","method":"get","path":"/config/logos/{logoId}"}}