DataIntegrationAuthorizeUrlResponse
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $completion : string|null
- `finish_required` when the request included `code_challenge`: the connection will be held until your app finishes it. Omitted otherwise. If you sent `code_challenge` and this is missing, don't redirect the user.
- $state : string
- Identifies this authorization. WorkOS adds it to `return_to` alongside `connect_code` or `error`. Store it in the user's session with the `code_verifier` and compare it when the user returns.
- $url : string
- The OAuth authorization URL to redirect the user to.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>|stdClass
- toArray() : array<string|int, mixed>
Properties
$completion
`finish_required` when the request included `code_challenge`: the connection will be held until your app finishes it. Omitted otherwise. If you sent `code_challenge` and this is missing, don't redirect the user.
public
string|null
$completion
= null
$state
Identifies this authorization. WorkOS adds it to `return_to` alongside `connect_code` or `error`. Store it in the user's session with the `code_verifier` and compare it when the user returns.
public
string
$state
$url
The OAuth authorization URL to redirect the user to.
public
string
$url
Methods
__construct()
public
__construct(string $url, string $state[, string|null $completion = null ]) : mixed
Parameters
- $url : string
- $state : string
- $completion : string|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>