WorkOS PHP SDK

DataIntegrationInstallation
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$accountDisplayName  : string|null
A mutable, non-unique display name for this connection.
$accountIdentifier  : string|null
A best-effort provider account identifier used for correlation, not connection selection.
$apiKeyLast4  : string|null
The last four characters of the stored API key. The full key is never returned.
$connectionRole  : ConnectedAccountConnectionRole
Whether this is the compatibility connection visible to undeclared clients or a standard connection for plural-aware clients.
$id  : string
Unique identifier of the installation.
$organizationId  : string|null
The Organization the installation is scoped to (or owned by, on an `organization`-owned integration), or null when unscoped.
$userId  : string|null
The User the API key was installed for. Null on an `organization`-owned integration, whose installations belong to the organization.

Methods

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

Properties

$accountIdentifier

A best-effort provider account identifier used for correlation, not connection selection.

public string|null $accountIdentifier

$apiKeyLast4

The last four characters of the stored API key. The full key is never returned.

public string|null $apiKeyLast4

$organizationId

The Organization the installation is scoped to (or owned by, on an `organization`-owned integration), or null when unscoped.

public string|null $organizationId

$userId

The User the API key was installed for. Null on an `organization`-owned integration, whose installations belong to the organization.

public string|null $userId

Methods

__construct()

public __construct(string $id, ConnectedAccountConnectionRole $connectionRole, string|null $accountIdentifier, string|null $accountDisplayName, string|null $userId, string|null $organizationId, string|null $apiKeyLast4) : mixed
Parameters
$id : string
$connectionRole : ConnectedAccountConnectionRole
$accountIdentifier : string|null
$accountDisplayName : string|null
$userId : string|null
$organizationId : string|null
$apiKeyLast4 : string|null

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

jsonSerialize()

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

Search results