Directory
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $createdAt : DateTimeImmutable
- An ISO 8601 timestamp.
- $domain : string|null
- The URL associated with an Enterprise Client.
- $externalKey : string
- External Key for the Directory.
- $id : string
- Unique identifier for the Directory.
- $metadata : DirectoryMetadata|null
- Aggregate counts of directory users and groups synced from the provider.
- $name : string
- The name of the directory.
- $object : string
- Distinguishes the Directory object.
- $organizationId : string
- The unique identifier for the Organization in which the directory resides.
- $state : DirectoryState
- Describes whether the Directory has been successfully connected to an external provider.
- $type : DirectoryType
- The type of external Directory Provider integrated with.
- $updatedAt : DateTimeImmutable
- An ISO 8601 timestamp.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$createdAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$createdAt
$domain
The URL associated with an Enterprise Client.
public
string|null
$domain
= null
$externalKey
External Key for the Directory.
public
string
$externalKey
$id
Unique identifier for the Directory.
public
string
$id
$metadata
Aggregate counts of directory users and groups synced from the provider.
public
DirectoryMetadata|null
$metadata
= null
$name
The name of the directory.
public
string
$name
$object
Distinguishes the Directory object.
public
string
$object
$organizationId
The unique identifier for the Organization in which the directory resides.
public
string
$organizationId
$state
Describes whether the Directory has been successfully connected to an external provider.
public
DirectoryState
$state
$type
The type of external Directory Provider integrated with.
public
DirectoryType
$type
$updatedAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$updatedAt
Methods
__construct()
public
__construct(string $object, string $id, string $organizationId, string $externalKey, DirectoryType $type, DirectoryState $state, string $name, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt[, string|null $domain = null ][, DirectoryMetadata|null $metadata = null ]) : mixed
Parameters
- $object : string
- $id : string
- $organizationId : string
- $externalKey : string
- $type : DirectoryType
- $state : DirectoryState
- $name : string
- $createdAt : DateTimeImmutable
- $updatedAt : DateTimeImmutable
- $domain : string|null = null
- $metadata : DirectoryMetadata|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>