WorkOS PHP SDK

DataIntegrationsGetDataIntegrationAuthorizeUrlRequest

in package

• Application

implements JsonSerializable uses JsonSerializableTrait

Table of Contents

Interfaces

JsonSerializable

Properties

$accountDisplayName  : string|null

A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.

$codeChallenge  : string|null

A PKCE-style code challenge: the base64url-encoded SHA-256 of a `code_verifier` your app keeps. When set, the connection isn't saved when the user finishes authorizing. Instead, the user is redirected to `return_to` with a `connect_code` and `state`, and your app must call [Finish connection](https://workos.com/docs/reference/pipes/connected-account/finish-connection) with the `connect_code` and `code_verifier` within 90 seconds to save it.

$codeChallengeMethod  : string|null

The method used to derive `code_challenge`. Only `S256` is supported, and it is the default. Requires `code_challenge`.

$config  : array<string, string>|null

Connect-time config values for the provider-declared `installation`-scope fields (e.g. a Zendesk `subdomain`), keyed by the config field. Only fields the provider declares may be supplied, and required fields must be provided unless already pinned on the integration.

$connectedAccountId  : string|null

The exact connected account to reauthorize. Required with `connection_intent: reauthorize` and not accepted otherwise.

$connectionIntent  : DataIntegrationsGetDataIntegrationAuthorizeUrlRequestConnectionIntent|null

Which connection the request targets. Omit it to use the compatibility connection. Send `add` to create another connection: the first connection for an owner shape fills the compatibility slot, and later connections are standard. Send `reauthorize` with `connected_account_id` to reauthorize one exact connection.

$connectionOwner  : PipesOwnership|null

Who will own the connected account. `user` (the default) connects the user's own account. `organization` connects the organization's shared account and requires `organization_id`.

$organizationId  : string|null

An organization ID to scope the authorization to a specific organization. Required when `connection_owner` is `organization`.

$returnTo  : string|null

The URL to redirect the user to after authorization. Required with `code_challenge`, and must then exactly match a redirect URI registered on one of the environment's applications. Loopback URLs match on any port; wildcard redirect URIs are not honored, and a `return_to` with a query string or fragment never matches.

$userId  : string

The ID of the user to authorize. When `connection_owner` is `organization`, this is the user authorizing on behalf of the organization; they must be an active member of the organization and do not become the owner of the resulting connected account.

Methods

__construct()  : mixed

fromArray()  : self

jsonSerialize()  : array<string|int, mixed>|stdClass

toArray()  : array<string|int, mixed>