DataIntegrationAccessTokenResponse
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $accessToken : DataIntegrationAccessTokenResponseAccessToken|null
- The [access token](https://workos.com/docs/reference/pipes/access-token) object, present when `active` is `true`.
- $active : bool|null
- Indicates whether the access token is valid and ready for use, or if reauthorization is required.
- $error : DataIntegrationAccessTokenResponseError|null
- - `"not_installed"`: The user does not have the integration installed.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$accessToken
The [access token](https://workos.com/docs/reference/pipes/access-token) object, present when `active` is `true`.
public
DataIntegrationAccessTokenResponseAccessToken|null
$accessToken
= null
$active
Indicates whether the access token is valid and ready for use, or if reauthorization is required.
public
bool|null
$active
= null
$error
- `"not_installed"`: The user does not have the integration installed.
public
DataIntegrationAccessTokenResponseError|null
$error
= null
"needs_reauthorization": The user needs to reauthorize the integration.
Methods
__construct()
public
__construct([bool|null $active = null ][, DataIntegrationAccessTokenResponseAccessToken|null $accessToken = null ][, DataIntegrationAccessTokenResponseError|null $error = null ]) : mixed
Parameters
- $active : bool|null = null
- $accessToken : DataIntegrationAccessTokenResponseAccessToken|null = null
- $error : DataIntegrationAccessTokenResponseError|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>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>