Documentation

DeveloperKey extends AbstractBaseApi

in package

• Application

Canvas Developer Keys API

Tags

see

https://canvas.instructure.com/doc/api/developer_keys.html

Table of Contents

Constants

AUDIENCE_EXTERNAL  = 'external'

AUDIENCE_INTERNAL  = 'internal'

STATE_ACTIVE  = 'active'

STATE_DELETED  = 'deleted'

STATE_INACTIVE  = 'inactive'

Properties

$accessTokenCount  : int|null

$accountName  : string|null

$allowIncludes  : bool|null

$apiKey  : string|null

$clientCredentialsAudience  : string|null

$createdAt  : string|null

$email  : string|null

$iconUrl  : string|null

$id  : int|null

$isLtiKey  : bool|null

$isLtiRegistration  : bool|null

$lastUsedAt  : string|null

$ltiRegistration  : array<string, mixed>|null

$name  : string|null

$notes  : string|null

$publicJwk  : array<string, mixed>|null

$publicJwkUrl  : string|null

$redirectUri  : string|null

$redirectUris  : array<string|int, string>|null

$requireScopes  : bool|null

$scopes  : array<string|int, string>|null

$testClusterOnly  : bool|null

$toolConfiguration  : array<string, mixed>|null

$updatedAt  : string|null

$userId  : string|null

$userName  : string|null

$vendorCode  : string|null

$visible  : bool|null

$workflowState  : string|null

$apiClient  : HttpClientInterface

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

BaseApi constructor.

all()  : array<string|int, static>

Get all pages of results

allowsIncludes()  : bool

Check if key allows includes parameters

create()  : self

Create a new developer key Uses account-scoped endpoint: POST /api/v1/accounts/:account_id/developer_keys

delete()  : array<string, mixed>

Delete a developer key Uses direct ID endpoint: DELETE /api/v1/developer_keys/:id

find()  : self

Find a developer key by ID Note: Canvas doesn't have a direct GET endpoint for individual developer keys This method fetches all keys and filters by ID

get()  : array<string|int, self>

Get all developer keys using account context Uses account-scoped endpoint: GET /api/v1/accounts/:account_id/developer_keys

getClientCredentialsAudienceDisplay()  : string|null

Get client credentials audience display name

getPaginated()  : PaginatedResponse

Get paginated developer keys

getRedirectUrisString()  : string|null

Get redirect URIs as comma-separated string

getScopesString()  : string|null

Get scopes as comma-separated string

getWithInherited()  : array<string|int, self>

Get developer keys with inherited keys from Site Admin

isActive()  : bool

Check if this developer key is active

isApiKey()  : bool

Check if this is a Canvas API key (vs LTI key)

isDeleted()  : bool

Check if this developer key is deleted

isInactive()  : bool

Check if this developer key is inactive

isLti()  : bool

Check if this is an LTI key (vs Canvas API key)

isTestClusterOnly()  : bool

Check if key is restricted to test cluster only

paginate()  : PaginationResult

Get paginated results with metadata

remove()  : array<string, mixed>

Delete this developer key instance

requiresScopes()  : bool

Check if key requires scopes in token requests

save()  : self

Update this developer key instance

setApiClient()  : void

Set the API client

update()  : self

Update an existing developer key Uses direct ID endpoint: PUT /api/v1/developer_keys/:id

castValue()  : DateTime|mixed

Cast a value to the correct type

checkApiClient()  : void

Check if the API client is set, if not, instantiate a new one

convertPaginatedResponseToModels()  : array<string|int, static>

Helper method to convert paginated response data to model instances

createConfiguredHttpClient()  : HttpClient

Create an HttpClient with configured middleware

createPaginationResult()  : PaginationResult

Helper method to create PaginationResult from paginated response

getEndpoint()  : string

Get the base endpoint for account-scoped operations (CREATE/LIST)

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

populate()  : void

Populate the object with new data

toDtoArray()  : array<string|int, mixed>

Convert the object to an array