DataIntegrationsGetDataIntegrationAuthorizeUrlRequest
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Table of Contents
Interfaces
- JsonSerializable
Properties
- $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.
- $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.
- $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>
- toArray() : array<string|int, mixed>
Properties
$config
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.
public
array<string, string>|null
$config
= null
$connectionOwner
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`.
public
PipesOwnership|null
$connectionOwner
= null
$organizationId
An organization ID to scope the authorization to a specific organization. Required when `connection_owner` is `organization`.
public
string|null
$organizationId
= null
$returnTo
The URL to redirect the user to after authorization.
public
string|null
$returnTo
= null
$userId
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.
public
string
$userId
Methods
__construct()
public
__construct(string $userId[, string|null $organizationId = null ][, PipesOwnership|null $connectionOwner = null ][, string|null $returnTo = null ][, array<string|int, mixed>|null $config = null ]) : mixed
Parameters
- $userId : string
- $organizationId : string|null = null
- $connectionOwner : PipesOwnership|null = null
- $returnTo : string|null = null
- $config : array<string|int, mixed>|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>