Documentation

BrandConfig
in package

BrandConfig API

Provides access to brand configuration variables for the current domain. This is a read-only API with a single endpoint that returns brand variables.

Canvas API Documentation: https://canvas.instructure.com/doc/api/brand_configs.html

Note: This class does not extend AbstractBaseApi as it only provides read-only access to brand variables with no CRUD operations.

Table of Contents

Methods

getBrandVariables()  : array<string, mixed>
Get brand config variables for the current domain
setApiClient()  : void
Set the API client for this class

Methods

getBrandVariables()

Get brand config variables for the current domain

public static getBrandVariables() : array<string, mixed>

Retrieves all brand variables used by this account. The endpoint redirects to a static JSON file containing the brand configuration. No authentication is required for this endpoint.

API Endpoint: GET /api/v1/brand_variables

Tags
throws
CanvasApiException

If the API request fails

example 
$brandVariables = BrandConfig::getBrandVariables();
echo $brandVariables['primary_color'];
echo $brandVariables['font_family'];
Return values
array<string, mixed> —

The brand configuration variables including colors, fonts, and logos

On this page

Search results