Download tenant logo
Request to download the logo image stored for a logo location of a tenant:
GET /api/v2/tenants/<tenant-id>/branding/logo/<location>
<location> is one of:
login_page- the logo of the Sign-In pageheader_menu- the logo of the top navigation bar
The response body is the raw image data. The Content-Type response header carries the image
format detected from the stored content (image/gif, image/jpeg, image/png, or
image/svg+xml).
Example with curl:
curl -u {login}:{password} -o logo.png \
https://{your-miarec-server}/api/v2/tenants/<tenant-id>/branding/logo/login_page
Caching
The response includes an ETag header that changes on every upload. A request that presents that
value in the If-None-Match header receives 304 Not Modified without the image data:
GET /api/v2/tenants/<tenant-id>/branding/logo/login_page
If-None-Match: "5d41402abc4b2a76b9719d911017c592"
Response contains HTTP status code as shown in the following table.
| Response | Description |
|---|---|
| 200 OK | Image data is returned in the response body |
| 304 Not Modified | The image has not changed since the ETag given in the If-None-Match request header. The response body is empty |
| 403 Forbidden | The request cannot be completed because API user has no permission to view branding |
| 404 Not Found | No logo image is stored for this location, the location is unknown, or the tenant does not exist or is not visible to the API user |