WorkOS PHP SDK

ApiKeyDataIntegrationVendedCredential
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$authMethod  : string
The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.
$config  : array<string, string>
Provider-declared, non-secret config from the installation snapshot, with current defaults for unset fields. Includes both integration- and installation-scope fields; omits undeclared fields and fields marked secret. Use these values to address a per-tenant host, such as Snowflake's `account` or Zendesk's `subdomain`. Empty when no values are disclosable. Changes to integration or organization pins require reconnecting or explicitly rebinding the connection. Defaults are live and can differ from a cached token's audience until refresh or re-mint.
$object  : string
Distinguishes the credential object.
$value  : string
The API key secret.

Methods

__construct()  : mixed
fromArray()  : self
jsonSerialize()  : array<string|int, mixed>
toArray()  : array<string|int, mixed>

Properties

$authMethod

The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.

public string $authMethod

$config

Provider-declared, non-secret config from the installation snapshot, with current defaults for unset fields. Includes both integration- and installation-scope fields; omits undeclared fields and fields marked secret. Use these values to address a per-tenant host, such as Snowflake's `account` or Zendesk's `subdomain`. Empty when no values are disclosable. Changes to integration or organization pins require reconnecting or explicitly rebinding the connection. Defaults are live and can differ from a cached token's audience until refresh or re-mint.

public array<string, string> $config

Methods

__construct()

public __construct(string $object, string $authMethod, string $value, array<string|int, mixed> $config) : mixed
Parameters
$object : string
$authMethod : string
$value : string
$config : array<string|int, mixed>

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results