AssignRoleToGroupRequest
in package
implements
JsonSerializable
The `AssignRoleToGroupRequest` schema from the server's OpenAPI document.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $groupId : string
- $inherit : bool|null
- $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
$groupId read-only
public
string
$groupId
$inherit read-only
public
bool|null
$inherit
= null
$resourceId read-only
public
string|null
$resourceId
= null
$tenantScope read-only
public
array<string|int, mixed>|null
$tenantScope
= null
Methods
__construct()
Constructs a AssignRoleToGroupRequest.
public
__construct(string $groupId[, bool|null $inherit = null ][, string|null $resourceId = null ][, array<int, string>|null $tenantScope = null ]) : mixed
Parameters
- $groupId : string
-
the server's
group_idfield - $inherit : bool|null = null
-
Whether the assignment also reaches the descendants of
resource_id. Omitted — the default — ortrueis today's behaviour: a resource-scoped assignment applies at its resource and everywhere below it.falseapplies it atresource_idonly, "here and no further", for allow and deny grants alike. Refused with 400 whenfalseis sent with noresource_id(a tenant-wide assignment has no node to stop at) or for a role withis_global: true(a global role applies everywhere by definition). The flag is part of the assignment: to change it, unassign and assign again. (optional) - $resourceId : string|null = null
-
the server's
resource_idfield (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
selfjsonSerialize()
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.