ConnectedAccount
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $createdAt : string
- The timestamp when the connection was created.
- $id : string
- The unique identifier of the connected account.
- $object : string
- Distinguishes the connected account object.
- $organizationId : string|null
- The [Organization](https://workos.com/docs/reference/organization) identifier associated with this connection, or `null` if not scoped to an organization.
- $scopes : array<string|int, string>
- The OAuth scopes granted for this connection.
- $state : ConnectedAccountState
- The state of the connected account: - `connected`: The connection is active and tokens are valid.
- $updatedAt : string
- The timestamp when the connection was last updated.
- $userId : string|null
- The [User](https://workos.com/docs/reference/authkit/user) identifier associated with this connection.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$createdAt
The timestamp when the connection was created.
public
string
$createdAt
$id
The unique identifier of the connected account.
public
string
$id
$object
Distinguishes the connected account object.
public
string
$object
$organizationId
The [Organization](https://workos.com/docs/reference/organization) identifier associated with this connection, or `null` if not scoped to an organization.
public
string|null
$organizationId
$scopes
The OAuth scopes granted for this connection.
public
array<string|int, string>
$scopes
$state
The state of the connected account: - `connected`: The connection is active and tokens are valid.
public
ConnectedAccountState
$state
needs_reauthorization: The user needs to reauthorize the connection, typically because required scopes have changed.disconnected: The connection has been disconnected.
$updatedAt
The timestamp when the connection was last updated.
public
string
$updatedAt
$userId
The [User](https://workos.com/docs/reference/authkit/user) identifier associated with this connection.
public
string|null
$userId
Methods
__construct()
public
__construct(string $object, string $id, string|null $userId, string|null $organizationId, array<string|int, mixed> $scopes, ConnectedAccountState $state, string $createdAt, string $updatedAt) : mixed
Parameters
- $object : string
- $id : string
- $userId : string|null
- $organizationId : string|null
- $scopes : array<string|int, mixed>
- $state : ConnectedAccountState
- $createdAt : string
- $updatedAt : string
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>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>