DataIntegrationsUpsertClientCredentialsRequest
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Table of Contents
Interfaces
- JsonSerializable
Properties
- $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
- A [connected account](https://workos.com/docs/reference/pipes/connected-account) identifier. Use this to rotate a specific existing connection.
- $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
$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
A [connected account](https://workos.com/docs/reference/pipes/connected-account) identifier. Use this to rotate a specific existing connection.
public
string|null
$connectedAccountId
= 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 $organizationId = null ][, string|null $connectedAccountId = null ][, PipesOwnership|null $connectionOwner = null ][, array<string|int, mixed>|null $config = null ]) : mixed
Parameters
- $userId : string
- $clientId : string
- $clientSecret : string
- $organizationId : string|null = null
- $connectedAccountId : string|null = null
- $connectionOwner : PipesOwnership|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>