CreateOrganizationAdmin implements ModelInterface, ArrayAccess
CreateOrganizationAdmin Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- AUTHENTICATION_METHOD_CISCO_SECURE_X_SIGN_ON = 'Cisco SecureX Sign-On'
- AUTHENTICATION_METHOD_EMAIL = 'Email'
- DISCRIMINATOR = null
- ORG_ACCESS_ENTERPRISE = 'enterprise'
- ORG_ACCESS_FULL = 'full'
- ORG_ACCESS_NONE = 'none'
- ORG_ACCESS_READ_ONLY = 'read-only'
- $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
- getAuthenticationMethod() : string
- Gets authentication_method
- getAuthenticationMethodAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getEmail() : string
- Gets email
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getNetworks() : array<string|int, OrganizationsorganizationIdadminsNetworks>
- Gets networks
- getOrgAccess() : string
- Gets org_access
- getOrgAccessAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTags() : array<string|int, OrganizationsorganizationIdadminsTags>
- Gets tags
- 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.
- setAuthenticationMethod() : $this
- Sets authentication_method
- setEmail() : $this
- Sets email
- setName() : $this
- Sets name
- setNetworks() : $this
- Sets networks
- setOrgAccess() : $this
- Sets org_access
- setTags() : $this
- Sets tags
- 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
AUTHENTICATION_METHOD_CISCO_SECURE_X_SIGN_ON
public
mixed
AUTHENTICATION_METHOD_CISCO_SECURE_X_SIGN_ON
= 'Cisco SecureX Sign-On'
AUTHENTICATION_METHOD_EMAIL
public
mixed
AUTHENTICATION_METHOD_EMAIL
= 'Email'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
ORG_ACCESS_ENTERPRISE
public
mixed
ORG_ACCESS_ENTERPRISE
= 'enterprise'
ORG_ACCESS_FULL
public
mixed
ORG_ACCESS_FULL
= 'full'
ORG_ACCESS_NONE
public
mixed
ORG_ACCESS_NONE
= 'none'
ORG_ACCESS_READ_ONLY
public
mixed
ORG_ACCESS_READ_ONLY
= 'read-only'
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', 'org_access' => 'orgAccess', 'tags' => 'tags', 'networks' => 'networks', 'authentication_method' => 'authenticationMethod']
$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', 'org_access' => 'getOrgAccess', 'tags' => 'getTags', 'networks' => 'getNetworks', 'authentication_method' => 'getAuthenticationMethod']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['email' => 'setEmail', 'name' => 'setName', 'org_access' => 'setOrgAccess', 'tags' => 'setTags', 'networks' => 'setNetworks', 'authentication_method' => 'setAuthenticationMethod']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['email' => null, 'name' => null, 'org_access' => null, 'tags' => null, 'networks' => null, 'authentication_method' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'createOrganizationAdmin'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['email' => 'string', 'name' => 'string', 'org_access' => 'string', 'tags' => '\Swagger\Client\Model\OrganizationsorganizationIdadminsTags[]', 'networks' => '\Swagger\Client\Model\OrganizationsorganizationIdadminsNetworks[]', 'authentication_method' => 'string']
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> —getAuthenticationMethod()
Gets authentication_method
public
getAuthenticationMethod() : string
Return values
string —getAuthenticationMethodAllowableValues()
Gets allowable values of the enum
public
getAuthenticationMethodAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getEmail()
Gets email
public
getEmail() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getNetworks()
Gets networks
public
getNetworks() : array<string|int, OrganizationsorganizationIdadminsNetworks>
Return values
array<string|int, OrganizationsorganizationIdadminsNetworks> —getOrgAccess()
Gets org_access
public
getOrgAccess() : string
Return values
string —getOrgAccessAllowableValues()
Gets allowable values of the enum
public
getOrgAccessAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTags()
Gets tags
public
getTags() : array<string|int, OrganizationsorganizationIdadminsTags>
Return values
array<string|int, OrganizationsorganizationIdadminsTags> —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 —setAuthenticationMethod()
Sets authentication_method
public
setAuthenticationMethod(string $authentication_method) : $this
Parameters
- $authentication_method : string
-
The method of authentication the user will use to sign in to the Meraki dashboard. Can be one of 'Email' or 'Cisco SecureX Sign-On'. The default is Email authentication
Return values
$this —setEmail()
Sets email
public
setEmail(string $email) : $this
Parameters
- $email : string
-
The email of the dashboard administrator. This attribute can not be updated.
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
-
The name of the dashboard administrator
Return values
$this —setNetworks()
Sets networks
public
setNetworks(array<string|int, OrganizationsorganizationIdadminsNetworks> $networks) : $this
Parameters
- $networks : array<string|int, OrganizationsorganizationIdadminsNetworks>
-
The list of networks that the dashboard administrator has privileges on
Return values
$this —setOrgAccess()
Sets org_access
public
setOrgAccess(string $org_access) : $this
Parameters
- $org_access : string
-
The privilege of the dashboard administrator on the organization. Can be one of 'full', 'read-only', 'enterprise' or 'none'
Return values
$this —setTags()
Sets tags
public
setTags(array<string|int, OrganizationsorganizationIdadminsTags> $tags) : $this
Parameters
- $tags : array<string|int, OrganizationsorganizationIdadminsTags>
-
The list of tags that the dashboard administrator has privileges on
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