Organization
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $allowProfilesOutsideOrganization : bool|null
- Whether the Organization allows profiles outside of its managed domains.
- $createdAt : DateTimeImmutable
- An ISO 8601 timestamp.
- $domains : array<string|int, OrganizationDomain>
- List of Organization Domains.
- $externalId : string|null
- The external ID of the Organization.
- $id : string
- Unique identifier of the Organization.
- $metadata : array<string, string>
- Object containing [metadata](https://workos.com/docs/authkit/metadata) key/value pairs associated with the Organization.
- $name : string
- A descriptive name for the Organization. This field does not need to be unique.
- $object : string
- Distinguishes the Organization object.
- $stripeCustomerId : string|null
- The Stripe customer ID of the Organization.
- $updatedAt : DateTimeImmutable
- An ISO 8601 timestamp.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$allowProfilesOutsideOrganization
Whether the Organization allows profiles outside of its managed domains.
public
bool|null
$allowProfilesOutsideOrganization
= null
$createdAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$createdAt
$domains
List of Organization Domains.
public
array<string|int, OrganizationDomain>
$domains
$externalId
The external ID of the Organization.
public
string|null
$externalId
$id
Unique identifier of the Organization.
public
string
$id
$metadata
Object containing [metadata](https://workos.com/docs/authkit/metadata) key/value pairs associated with the Organization.
public
array<string, string>
$metadata
$name
A descriptive name for the Organization. This field does not need to be unique.
public
string
$name
$object
Distinguishes the Organization object.
public
string
$object
$stripeCustomerId
The Stripe customer ID of the Organization.
public
string|null
$stripeCustomerId
= null
$updatedAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$updatedAt
Methods
__construct()
public
__construct(string $object, string $id, string $name, array<string|int, mixed> $domains, array<string|int, mixed> $metadata, string|null $externalId, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt[, string|null $stripeCustomerId = null ][, bool|null $allowProfilesOutsideOrganization = null ]) : mixed
Parameters
- $object : string
- $id : string
- $name : string
- $domains : array<string|int, mixed>
- $metadata : array<string|int, mixed>
- $externalId : string|null
- $createdAt : DateTimeImmutable
- $updatedAt : DateTimeImmutable
- $stripeCustomerId : string|null = null
- $allowProfilesOutsideOrganization : bool|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>