WorkOS PHP SDK

AgentBlueprintsCreateRequest
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$description  : string|null
Human-readable description of the agent blueprint.
$invocableBy  : AgentBlueprintsCreateRequestInvocableBy|null
Who may mint sessions from this blueprint.
$name  : string
Human-readable name of the agent blueprint.
$permissions  : array<string|int, string>|null
Permission slugs forming the ceiling on what sessions minted from this blueprint may do. Each slug must exist in the environment.
$sessionSettings  : AgentBlueprintsCreateRequestSessionSetting|null
Token and session lifetimes for sessions minted from this blueprint.

Methods

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

Properties

$permissions

Permission slugs forming the ceiling on what sessions minted from this blueprint may do. Each slug must exist in the environment.

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

Methods

__construct()

public __construct(string $name[, string|null $description = null ][, array<string|int, mixed>|null $permissions = null ][, AgentBlueprintsCreateRequestInvocableBy|null $invocableBy = null ][, AgentBlueprintsCreateRequestSessionSetting|null $sessionSettings = null ]) : mixed
Parameters
$name : string
$description : string|null = null
$permissions : array<string|int, mixed>|null = null
$invocableBy : AgentBlueprintsCreateRequestInvocableBy|null = null
$sessionSettings : AgentBlueprintsCreateRequestSessionSetting|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>
On this page

Search results