DataIntegrationsUpsertClientCredentialsRequest
in package
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.
- $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.
- $connectedAccountId : string|null
- The exact connected account to reauthorize. Required with `connection_intent: reauthorize`; it may also be sent on its own to reauthorize that connection.
- $connectionIntent : string|null
- Send `reauthorize` with `connected_account_id` to reauthorize one exact connection. Omit it to use the compatibility connection; creating another connection lives on the POST route.
- $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>|stdClass
- toArray() : array<string|int, mixed>
Properties
$accountDisplayName
A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
public
string|null
$accountDisplayName
= null
$accountIdentifier
A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
public
string|null
$accountIdentifier
= null
$clientId
The OAuth client ID to store for this integration.
public
string
$clientId
$clientSecret
The OAuth client secret to store for this integration.
public
string
$clientSecret
$config
Provider-specific configuration values collected for this installation, keyed by the provider's config field descriptors.
public
array<string, string>|null
$config
= null
$connectedAccountId
The exact connected account to reauthorize. Required with `connection_intent: reauthorize`; it may also be sent on its own to reauthorize that connection.
public
string|null
$connectedAccountId
= null
$connectionIntent
Send `reauthorize` with `connected_account_id` to reauthorize one exact connection. Omit it to use the compatibility connection; creating another connection lives on the POST route.
public
string|null
$connectionIntent
= null
$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
$userId
A [User](https://workos.com/docs/reference/authkit/user) identifier.
public
string
$userId
Methods
__construct()
public
__construct(string $userId, string $clientId, string $clientSecret[, string|null $accountDisplayName = null ][, string|null $accountIdentifier = null ][, string|null $organizationId = null ][, PipesOwnership|null $connectionOwner = null ][, array<string|int, mixed>|null $config = null ][, string|null $connectionIntent = null ][, string|null $connectedAccountId = null ]) : mixed
Parameters
- $userId : string
- $clientId : string
- $clientSecret : string
- $accountDisplayName : string|null = null
- $accountIdentifier : string|null = null
- $organizationId : string|null = null
- $connectionOwner : PipesOwnership|null = null
- $config : array<string|int, mixed>|null = null
- $connectionIntent : string|null = null
- $connectedAccountId : 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>