CockpitAddRegistrationPayload
in package
implements
OfcpEvent
FinalYes
Payload for add an user to the Cockpit
Table of Contents
Interfaces
- OfcpEvent
- Basic interface for OFCP-Events.
Properties
- $expirationDate : mixed|null
- $organisationId : string
- $password : string
- $role : string
- $user : User
Methods
- __construct() : self
- Payload for add an user to the Cockpit
- from_json() : self
- Parse JSON data into an instance of this class.
- getExpirationDate() : mixed
- getOrganisationId() : string
- getPassword() : string
- getRole() : string
- getUser() : User
- jsonSerialize() : array<string|int, mixed>
- setExpirationDate() : void
- setOrganisationId() : void
- setPassword() : void
- setRole() : void
- setUser() : void
Properties
$expirationDate
private
mixed|null
$expirationDate
$organisationId
private
string
$organisationId
$password
private
string
$password
$role
private
string
$role
$user
private
User
$user
Methods
__construct()
Payload for add an user to the Cockpit
public
__construct(mixed $expirationDate, string $organisationId, string $password, string $role, User $user) : self
Parameters
- $expirationDate : mixed
- $organisationId : string
- $password : string
- $role : string
- $user : User
-
user data attributes username, name, email, are Required and are self explaining type: is Required and Define the type of the user [internal┃external┃service_account┃internal_service_account] groups : Optional, array of uuids of the groups the user is in
Return values
selffrom_json()
Parse JSON data into an instance of this class.
public
static from_json(string|array<string|int, mixed> $json) : self
Parameters
- $json : string|array<string|int, mixed>
-
JSON data to parse.
Return values
selfgetExpirationDate()
public
getExpirationDate() : mixed
getOrganisationId()
public
getOrganisationId() : string
Return values
stringgetPassword()
public
getPassword() : string
Return values
stringgetRole()
public
getRole() : string
Return values
stringgetUser()
public
getUser() : User
Return values
UserjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>setExpirationDate()
public
setExpirationDate(mixed $expirationDate) : void
Parameters
- $expirationDate : mixed
setOrganisationId()
public
setOrganisationId(string $organisationId) : void
Parameters
- $organisationId : string
setPassword()
public
setPassword(string $password) : void
Parameters
- $password : string
setRole()
public
setRole(string $role) : void
Parameters
- $role : string
setUser()
public
setUser(User $user) : void
Parameters
- $user : User