AXIAM PHP SDK

AssignRoleToGroupRequest
in package
implements JsonSerializable

FinalYes

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

Table of Contents

Interfaces

JsonSerializable

Properties

$groupId  : string
$resourceId  : string|null
$tenantScope  : array<string|int, mixed>|null

Methods

__construct()  : mixed
Constructs a AssignRoleToGroupRequest.
fromArray()  : self
Rebuilds a AssignRoleToGroupRequest 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.

Properties

Methods

__construct()

Constructs a AssignRoleToGroupRequest.

public __construct(string $groupId[, string|null $resourceId = null ][, array<int, string>|null $tenantScope = null ]) : mixed
Parameters
$groupId : string

the server's group_id field

$resourceId : string|null = null

the server's resource_id field (optional)

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

The tenants this assignment reaches. Only meaningful for an assignment made in an organization's scope, whose global roles otherwise reach every tenant of the organization; naming tenants here confines the assignment to those and to nothing else, the organization's own scope included. Omitted — the default — reaches wherever the role does. Refused with 400 outside an organization scope, when empty, and when it names a tenant of another organization or the organization's own scope tenant. (optional)

fromArray()

Rebuilds a AssignRoleToGroupRequest 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).

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>
On this page

Search results