Reference

Client

Whenever you're dealing with a client in your template, you're actually working with a Client object.

Properties

name

The name of the client.

handle

The handle of the client.

enabled

Whether the client is enabled or not.

type

The type of client this is (oauth or credentials).

primaryColor

The primary brand color of the provider connected.

icon

The SVG icon of the client provider connected.

providerName

The name of the client provider connected.

Methods

isConfigured()

Returns whether the client has the settings it needs to make requests, such as a URL for a Generic credentials client, or a client ID and secret for an OAuth client.

isConnected()

Returns whether the client has a stored access token. This is always false for credentials clients.

getToken()

Returns the stored access token for an OAuth client, or null when the client isn’t connected.

Last updated: Nov 13, 2026, 3:09:39 PM