WorkOS PHP SDK

Profile
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$connectionId  : string
The ID of the SSO connection used for authentication.
$connectionType  : ConnectionType
The type of SSO connection.
$customAttributes  : array<string, mixed>|null
Custom attribute mappings defined for the connection, returned as key-value pairs.
$email  : string
The user's email address.
$firstName  : string|null
The user's first name.
$groups  : array<string|int, string>|null
The groups the user belongs to, as returned by the identity provider.
$id  : string
Unique identifier of the profile.
$idpId  : string
The user's unique identifier from the identity provider.
$lastName  : string|null
The user's last name.
$object  : string
Distinguishes the profile object.
$organizationId  : string|null
The ID of the organization the user belongs to.
$rawAttributes  : array<string, mixed>
The complete set of raw attributes returned by the identity provider.
$role  : SlimRole|null
The role assigned to the user within the organization, if applicable.
$roles  : array<string|int, SlimRole>|null
The roles assigned to the user within the organization, if applicable.

Methods

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

Properties

$connectionId

The ID of the SSO connection used for authentication.

public string $connectionId

$customAttributes

Custom attribute mappings defined for the connection, returned as key-value pairs.

public array<string, mixed>|null $customAttributes = null

$email

The user's email address.

public string $email

$firstName

The user's first name.

public string|null $firstName

$groups

The groups the user belongs to, as returned by the identity provider.

public array<string|int, string>|null $groups = null

$id

Unique identifier of the profile.

public string $id

$idpId

The user's unique identifier from the identity provider.

public string $idpId

$lastName

The user's last name.

public string|null $lastName

$object

Distinguishes the profile object.

public string $object

$organizationId

The ID of the organization the user belongs to.

public string|null $organizationId

$rawAttributes

The complete set of raw attributes returned by the identity provider.

public array<string, mixed> $rawAttributes

$role

The role assigned to the user within the organization, if applicable.

public SlimRole|null $role = null

$roles

The roles assigned to the user within the organization, if applicable.

public array<string|int, SlimRole>|null $roles = null

Methods

__construct()

public __construct(string $object, string $id, string|null $organizationId, string $connectionId, ConnectionType $connectionType, string $idpId, string $email, string|null $firstName, string|null $lastName, array<string|int, mixed> $rawAttributes[, SlimRole|null $role = null ][, array<string|int, mixed>|null $roles = null ][, array<string|int, mixed>|null $groups = null ][, array<string|int, mixed>|null $customAttributes = null ]) : mixed
Parameters
$object : string
$id : string
$organizationId : string|null
$connectionId : string
$connectionType : ConnectionType
$idpId : string
$email : string
$firstName : string|null
$lastName : string|null
$rawAttributes : array<string|int, mixed>
$role : SlimRole|null = null
$roles : array<string|int, mixed>|null = null
$groups : array<string|int, mixed>|null = null
$customAttributes : array<string|int, mixed>|null = null

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

jsonSerialize()

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

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results