CreateNetworkMerakiAuthUser implements ModelInterface, ArrayAccess
CreateNetworkMerakiAuthUser Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- ACCOUNT_TYPE__8021_X = '802.1X'
- ACCOUNT_TYPE_CLIENT_VPN = 'Client VPN'
- ACCOUNT_TYPE_GUEST = 'Guest'
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAccountType() : string
- Gets account_type
- getAccountTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getAuthorizations() : array<string|int, NetworksnetworkIdmerakiAuthUsersAuthorizations>
- Gets authorizations
- getEmail() : string
- Gets email
- getEmailPasswordToUser() : bool
- Gets email_password_to_user
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getPassword() : string
- Gets password
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAccountType() : $this
- Sets account_type
- setAuthorizations() : $this
- Sets authorizations
- setEmail() : $this
- Sets email
- setEmailPasswordToUser() : $this
- Sets email_password_to_user
- setName() : $this
- Sets name
- setPassword() : $this
- Sets password
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
ACCOUNT_TYPE__8021_X
public
mixed
ACCOUNT_TYPE__8021_X
= '802.1X'
ACCOUNT_TYPE_CLIENT_VPN
public
mixed
ACCOUNT_TYPE_CLIENT_VPN
= 'Client VPN'
ACCOUNT_TYPE_GUEST
public
mixed
ACCOUNT_TYPE_GUEST
= 'Guest'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['email' => 'email', 'name' => 'name', 'password' => 'password', 'account_type' => 'accountType', 'email_password_to_user' => 'emailPasswordToUser', 'authorizations' => 'authorizations']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['email' => 'getEmail', 'name' => 'getName', 'password' => 'getPassword', 'account_type' => 'getAccountType', 'email_password_to_user' => 'getEmailPasswordToUser', 'authorizations' => 'getAuthorizations']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['email' => 'setEmail', 'name' => 'setName', 'password' => 'setPassword', 'account_type' => 'setAccountType', 'email_password_to_user' => 'setEmailPasswordToUser', 'authorizations' => 'setAuthorizations']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['email' => null, 'name' => null, 'password' => null, 'account_type' => null, 'email_password_to_user' => null, 'authorizations' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'createNetworkMerakiAuthUser'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['email' => 'string', 'name' => 'string', 'password' => 'string', 'account_type' => 'string', 'email_password_to_user' => 'bool', 'authorizations' => '\Swagger\Client\Model\NetworksnetworkIdmerakiAuthUsersAuthorizations[]']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAccountType()
Gets account_type
public
getAccountType() : string
Return values
string —getAccountTypeAllowableValues()
Gets allowable values of the enum
public
getAccountTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getAuthorizations()
Gets authorizations
public
getAuthorizations() : array<string|int, NetworksnetworkIdmerakiAuthUsersAuthorizations>
Return values
array<string|int, NetworksnetworkIdmerakiAuthUsersAuthorizations> —getEmail()
Gets email
public
getEmail() : string
Return values
string —getEmailPasswordToUser()
Gets email_password_to_user
public
getEmailPasswordToUser() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getPassword()
Gets password
public
getPassword() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setAccountType()
Sets account_type
public
setAccountType(string $account_type) : $this
Parameters
- $account_type : string
-
Authorization type for user. Can be 'Guest' or '802.1X' for wireless networks, or 'Client VPN' for wired networks. Defaults to '802.1X'.
Return values
$this —setAuthorizations()
Sets authorizations
public
setAuthorizations(array<string|int, NetworksnetworkIdmerakiAuthUsersAuthorizations> $authorizations) : $this
Parameters
- $authorizations : array<string|int, NetworksnetworkIdmerakiAuthUsersAuthorizations>
-
Authorization zones and expiration dates for the user.
Return values
$this —setEmail()
Sets email
public
setEmail(string $email) : $this
Parameters
- $email : string
-
Email address of the user
Return values
$this —setEmailPasswordToUser()
Sets email_password_to_user
public
setEmailPasswordToUser(bool $email_password_to_user) : $this
Parameters
- $email_password_to_user : bool
-
Whether or not Meraki should email the password to user. Default is false.
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
-
Name of the user
Return values
$this —setPassword()
Sets password
public
setPassword(string $password) : $this
Parameters
- $password : string
-
The password for this user account
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid