OrganizationsorganizationIdbrandingPoliciesAdminSettings implements ModelInterface, ArrayAccess
OrganizationsorganizationIdbrandingPoliciesAdminSettings Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- APPLIES_TO_ALL_ADMINS = 'All admins'
- APPLIES_TO_ALL_ADMINS_OF_NETWORKS = 'All admins of networks...'
- APPLIES_TO_ALL_ADMINS_OF_NETWORKS_TAGGED = 'All admins of networks tagged...'
- APPLIES_TO_ALL_ENTERPRISE_ADMINS = 'All enterprise admins'
- APPLIES_TO_ALL_NETWORK_ADMINS = 'All network admins'
- APPLIES_TO_ALL_ORGANIZATION_ADMINS = 'All organization admins'
- APPLIES_TO_ALL_SAML_ADMINS = 'All SAML admins'
- APPLIES_TO_SPECIFIC_ADMINS = 'Specific admins...'
- 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
- getAppliesTo() : string
- Gets applies_to
- getAppliesToAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getValues() : array<string|int, string>
- Gets values
- 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.
- setAppliesTo() : $this
- Sets applies_to
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setValues() : $this
- Sets values
- 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
APPLIES_TO_ALL_ADMINS
public
mixed
APPLIES_TO_ALL_ADMINS
= 'All admins'
APPLIES_TO_ALL_ADMINS_OF_NETWORKS
public
mixed
APPLIES_TO_ALL_ADMINS_OF_NETWORKS
= 'All admins of networks...'
APPLIES_TO_ALL_ADMINS_OF_NETWORKS_TAGGED
public
mixed
APPLIES_TO_ALL_ADMINS_OF_NETWORKS_TAGGED
= 'All admins of networks tagged...'
APPLIES_TO_ALL_ENTERPRISE_ADMINS
public
mixed
APPLIES_TO_ALL_ENTERPRISE_ADMINS
= 'All enterprise admins'
APPLIES_TO_ALL_NETWORK_ADMINS
public
mixed
APPLIES_TO_ALL_NETWORK_ADMINS
= 'All network admins'
APPLIES_TO_ALL_ORGANIZATION_ADMINS
public
mixed
APPLIES_TO_ALL_ORGANIZATION_ADMINS
= 'All organization admins'
APPLIES_TO_ALL_SAML_ADMINS
public
mixed
APPLIES_TO_ALL_SAML_ADMINS
= 'All SAML admins'
APPLIES_TO_SPECIFIC_ADMINS
public
mixed
APPLIES_TO_SPECIFIC_ADMINS
= 'Specific admins...'
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
= ['applies_to' => 'appliesTo', 'values' => 'values']
$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
= ['applies_to' => 'getAppliesTo', 'values' => 'getValues']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['applies_to' => 'setAppliesTo', 'values' => 'setValues']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['applies_to' => null, 'values' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'organizationsorganizationIdbrandingPolicies_adminSettings'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['applies_to' => 'string', 'values' => '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> —getAppliesTo()
Gets applies_to
public
getAppliesTo() : string
Return values
string —getAppliesToAllowableValues()
Gets allowable values of the enum
public
getAppliesToAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : 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> —getValues()
Gets values
public
getValues() : array<string|int, string>
Return values
array<string|int, string> —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 —setAppliesTo()
Sets applies_to
public
setAppliesTo(string $applies_to) : $this
Parameters
- $applies_to : string
-
Which kinds of admins this policy applies to. Can be one of 'All organization admins', 'All enterprise admins', 'All network admins', 'All admins of networks...', 'All admins of networks tagged...', 'Specific admins...', 'All admins' or 'All SAML admins'.
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> —setValues()
Sets values
public
setValues(array<string|int, string> $values) : $this
Parameters
- $values : array<string|int, string>
-
If 'appliesTo' is set to one of 'Specific admins...', 'All admins of networks...' or 'All admins of networks tagged...', then you must specify this 'values' property to provide the set of entities to apply the branding policy to. For 'Specific admins...', specify an array of admin IDs. For 'All admins of networks...', specify an array of network IDs and/or configuration template IDs. For 'All admins of networks tagged...', specify an array of tag names.
Return values
$this —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