AXIAM PHP SDK

GrantPermissionRequest
in package
implements JsonSerializable

FinalYes

The `GrantPermissionRequest` schema from the server's OpenAPI document.

Table of Contents

Interfaces

JsonSerializable

Properties

$effect  : PermissionEffect|null
$permissionId  : string
$scopeIds  : array<string|int, mixed>|null

Methods

__construct()  : mixed
Constructs a GrantPermissionRequest.
fromArray()  : self
Rebuilds a GrantPermissionRequest from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this object for `json_encode()`.
toArray()  : array<string, mixed>
Renders this object back to its wire form.
unknownEnumValue()  : string|null
The string the server sent for an open-enum member this SDK has no name for, or `null`.

Properties

Methods

__construct()

Constructs a GrantPermissionRequest.

public __construct(string $permissionId[, PermissionEffect|null $effect = null ][, array<int, string>|null $scopeIds = null ]) : mixed
Parameters
$permissionId : string

the server's permission_id field

$effect : PermissionEffect|null = null

B1: "allow" (the default) or "deny". A deny grant overrides every allow, at any depth of the resource hierarchy and at equal specificity — it is not most-specific-wins. See claude_dev/deny-override-design.md for the precedence table and for why that trade was made. Omitting the field means "allow", so every existing client keeps working unchanged and no migration is required. (optional)

$scopeIds : array<int, string>|null = null

the server's scope_ids field (optional)

fromArray()

Rebuilds a GrantPermissionRequest from one decoded JSON object.

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

The raw wire object.

Return values
self

jsonSerialize()

Renders this object for `json_encode()`.

public jsonSerialize() : array<string, mixed>

Any Sensitive it carries stays WRAPPED here, so a log line or a json_encode($model) in application code prints [SENSITIVE]. The one place a secret is revealed is ManagementTransport, on the way to the wire and nowhere else (§27.5).

Rendering for a log line never fails: an unknown union arm renders its discriminator and an unrecognised enum value its empty Unknown spelling here, and only self::toArray() -- the request path -- refuses to send it (CONTRACT.md §31.2, §34.2 P12.2).

Return values
array<string, mixed>

toArray()

Renders this object back to its wire form.

public toArray() : array<string, mixed>

§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.

Return values
array<string, mixed>

unknownEnumValue()

The string the server sent for an open-enum member this SDK has no name for, or `null`.

public unknownEnumValue(string $wire) : string|null

Only a model decoded by self::fromArray() knows it, and only for a member that decoded to Unknown (CONTRACT.md §27.6.2 item 4, §34.8 (c)): it lets a refusal name the value. It is for messages -- it is never rendered by self::toArray() or self::jsonSerialize() and so is never sent.

Parameters
$wire : string

The member's wire name.

Return values
string|null
On this page

Search results