WorkOS PHP SDK

DataIntegrationsCreateClientCredentialsConnectionRequest
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

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.
$accountIdentifier  : string|null
A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
$clientId  : string
The OAuth client ID to store for this integration.
$clientSecret  : string
The OAuth client secret to store for this integration.
$config  : array<string, string>|null
Provider-specific configuration values collected for this installation, keyed by the provider's config field descriptors.
$connectionIntent  : string
Must be `add`: this endpoint only creates another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard.
$connectionOwner  : PipesOwnership|null
Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.
$organizationId  : string|null
An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
$userId  : string
A [User](https://workos.com/docs/reference/authkit/user) identifier.

Methods

__construct()  : mixed
fromArray()  : self
jsonSerialize()  : array<string|int, mixed>
toArray()  : array<string|int, mixed>

Properties

$connectionOwner

Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.

public PipesOwnership|null $connectionOwner = null

$organizationId

An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.

public string|null $organizationId = null

Methods

__construct()

public __construct(string $userId, string $clientId, string $clientSecret, string $connectionIntent[, string|null $accountDisplayName = null ][, string|null $accountIdentifier = null ][, string|null $organizationId = null ][, PipesOwnership|null $connectionOwner = null ][, array<string|int, mixed>|null $config = null ]) : mixed
Parameters
$userId : string
$clientId : string
$clientSecret : string
$connectionIntent : string
$accountDisplayName : string|null = null
$accountIdentifier : string|null = null
$organizationId : string|null = null
$connectionOwner : PipesOwnership|null = null
$config : array<string|int, mixed>|null = null

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results