ConnectedAccountInput
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Table of Contents
Interfaces
- JsonSerializable
Properties
- $accessToken : string|null
- The OAuth access token for the connected account.
- $accountDisplayName : string|null
- A mutable, non-unique connection label; null clears it. Not an account identifier.
- $accountIdentifier : string|null
- A developer-attested account identifier; null clears it.
- $config : array<string, string>|null
- Installation-scoped provider configuration for this connection, such as Salesforce salesforce_host. Imports apply supplied values over installation-scoped integration pins and inherit other config from the credential source. Credential-bearing imports must satisfy required configuration even when config is omitted or {}. On update, a supplied object replaces installation-scoped values; omitted config preserves the stored snapshot. Stored integration-scoped values remain bound to the OAuth client and cannot be overridden or replaced with current integration pins. Replacements must satisfy required configuration; {} and empty-string values clear installation-scoped values only when the result is valid. Provider defaults count toward completeness but are resolved at read time, not stored. Only tokenless needs_reauthorization placeholders may remain incomplete; attaching their first tokens validates configuration even when config is omitted. Unrelated updates do not revalidate unchanged configuration. Clearing salesforce_host falls back to login.salesforce.com, which may not work for sandbox or My Domain-only connections.
- $expiresAt : DateTimeImmutable|null
- The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire.
- $refreshToken : string|null
- The OAuth refresh token for the connected account.
- $scopes : array<string|int, string>|null
- The OAuth scopes granted for this connection.
- $state : PipeConnectedAccountState|null
- Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>|stdClass
- toArray() : array<string|int, mixed>
Properties
$accessToken
The OAuth access token for the connected account.
public
string|null
$accessToken
= null
$accountDisplayName
A mutable, non-unique connection label; null clears it. Not an account identifier.
public
string|null
$accountDisplayName
= null
$accountIdentifier
A developer-attested account identifier; null clears it.
public
string|null
$accountIdentifier
= null
$config
Installation-scoped provider configuration for this connection, such as Salesforce salesforce_host. Imports apply supplied values over installation-scoped integration pins and inherit other config from the credential source. Credential-bearing imports must satisfy required configuration even when config is omitted or {}. On update, a supplied object replaces installation-scoped values; omitted config preserves the stored snapshot. Stored integration-scoped values remain bound to the OAuth client and cannot be overridden or replaced with current integration pins. Replacements must satisfy required configuration; {} and empty-string values clear installation-scoped values only when the result is valid. Provider defaults count toward completeness but are resolved at read time, not stored. Only tokenless needs_reauthorization placeholders may remain incomplete; attaching their first tokens validates configuration even when config is omitted. Unrelated updates do not revalidate unchanged configuration. Clearing salesforce_host falls back to login.salesforce.com, which may not work for sandbox or My Domain-only connections.
public
array<string, string>|null
$config
= null
$expiresAt
The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire.
public
DateTimeImmutable|null
$expiresAt
= null
$refreshToken
The OAuth refresh token for the connected account.
public
string|null
$refreshToken
= null
$scopes
The OAuth scopes granted for this connection.
public
array<string|int, string>|null
$scopes
= null
$state
Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
public
PipeConnectedAccountState|null
$state
= null
Methods
__construct()
public
__construct([string|null $accountDisplayName = null ][, string|null $accountIdentifier = null ][, array<string|int, mixed>|null $config = null ][, string|null $accessToken = null ][, string|null $refreshToken = null ][, DateTimeImmutable|null $expiresAt = null ][, array<string|int, mixed>|null $scopes = null ][, PipeConnectedAccountState|null $state = null ]) : mixed
Parameters
- $accountDisplayName : string|null = null
- $accountIdentifier : string|null = null
- $config : array<string|int, mixed>|null = null
- $accessToken : string|null = null
- $refreshToken : string|null = null
- $expiresAt : DateTimeImmutable|null = null
- $scopes : array<string|int, mixed>|null = null
- $state : PipeConnectedAccountState|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>|stdClass
Return values
array<string|int, mixed>|stdClasstoArray()
public
toArray() : array<string|int, mixed>