CreateScimTokenRequest
in package
implements
JsonSerializable
The `CreateScimTokenRequest` schema from the server's OpenAPI document.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $expiresInDays : int|null
- $name : string
- $userId : string
Methods
- __construct() : mixed
- Constructs a CreateScimTokenRequest.
- fromArray() : self
- Rebuilds a CreateScimTokenRequest 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
$expiresInDays read-only
public
int|null
$expiresInDays
= null
$name read-only
public
string
$name
$userId read-only
public
string
$userId
Methods
__construct()
Constructs a CreateScimTokenRequest.
public
__construct(string $name, string $userId[, int|null $expiresInDays = null ]) : mixed
Parameters
- $name : string
-
Operator-facing label, e.g.
"okta-production". - $userId : string
-
The tenant user the token authenticates as. Must already hold
scim:provision— see [create]. - $expiresInDays : int|null = null
-
Lifetime in days. Defaults to the deployment maximum, and is refused above it. (optional)
fromArray()
Rebuilds a CreateScimTokenRequest 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.