Documentation

UpdateOrganizationLoginSecurity implements ModelInterface, ArrayAccess

UpdateOrganizationLoginSecurity Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes and Traits

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

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
getAccountLockoutAttempts()  : int
Gets account_lockout_attempts
getEnforceAccountLockout()  : bool
Gets enforce_account_lockout
getEnforceDifferentPasswords()  : bool
Gets enforce_different_passwords
getEnforceIdleTimeout()  : bool
Gets enforce_idle_timeout
getEnforceLoginIpRanges()  : bool
Gets enforce_login_ip_ranges
getEnforcePasswordExpiration()  : bool
Gets enforce_password_expiration
getEnforceStrongPasswords()  : bool
Gets enforce_strong_passwords
getEnforceTwoFactorAuth()  : bool
Gets enforce_two_factor_auth
getIdleTimeoutMinutes()  : int
Gets idle_timeout_minutes
getLoginIpRanges()  : array<string|int, string>
Gets login_ip_ranges
getModelName()  : string
The original name of the model.
getNumDifferentPasswords()  : int
Gets num_different_passwords
getPasswordExpirationDays()  : int
Gets password_expiration_days
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.
setAccountLockoutAttempts()  : $this
Sets account_lockout_attempts
setEnforceAccountLockout()  : $this
Sets enforce_account_lockout
setEnforceDifferentPasswords()  : $this
Sets enforce_different_passwords
setEnforceIdleTimeout()  : $this
Sets enforce_idle_timeout
setEnforceLoginIpRanges()  : $this
Sets enforce_login_ip_ranges
setEnforcePasswordExpiration()  : $this
Sets enforce_password_expiration
setEnforceStrongPasswords()  : $this
Sets enforce_strong_passwords
setEnforceTwoFactorAuth()  : $this
Sets enforce_two_factor_auth
setIdleTimeoutMinutes()  : $this
Sets idle_timeout_minutes
setLoginIpRanges()  : $this
Sets login_ip_ranges
setNumDifferentPasswords()  : $this
Sets num_different_passwords
setPasswordExpirationDays()  : $this
Sets password_expiration_days
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

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 = ['enforce_password_expiration' => 'enforcePasswordExpiration', 'password_expiration_days' => 'passwordExpirationDays', 'enforce_different_passwords' => 'enforceDifferentPasswords', 'num_different_passwords' => 'numDifferentPasswords', 'enforce_strong_passwords' => 'enforceStrongPasswords', 'enforce_account_lockout' => 'enforceAccountLockout', 'account_lockout_attempts' => 'accountLockoutAttempts', 'enforce_idle_timeout' => 'enforceIdleTimeout', 'idle_timeout_minutes' => 'idleTimeoutMinutes', 'enforce_two_factor_auth' => 'enforceTwoFactorAuth', 'enforce_login_ip_ranges' => 'enforceLoginIpRanges', 'login_ip_ranges' => 'loginIpRanges']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['enforce_password_expiration' => 'getEnforcePasswordExpiration', 'password_expiration_days' => 'getPasswordExpirationDays', 'enforce_different_passwords' => 'getEnforceDifferentPasswords', 'num_different_passwords' => 'getNumDifferentPasswords', 'enforce_strong_passwords' => 'getEnforceStrongPasswords', 'enforce_account_lockout' => 'getEnforceAccountLockout', 'account_lockout_attempts' => 'getAccountLockoutAttempts', 'enforce_idle_timeout' => 'getEnforceIdleTimeout', 'idle_timeout_minutes' => 'getIdleTimeoutMinutes', 'enforce_two_factor_auth' => 'getEnforceTwoFactorAuth', 'enforce_login_ip_ranges' => 'getEnforceLoginIpRanges', 'login_ip_ranges' => 'getLoginIpRanges']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['enforce_password_expiration' => 'setEnforcePasswordExpiration', 'password_expiration_days' => 'setPasswordExpirationDays', 'enforce_different_passwords' => 'setEnforceDifferentPasswords', 'num_different_passwords' => 'setNumDifferentPasswords', 'enforce_strong_passwords' => 'setEnforceStrongPasswords', 'enforce_account_lockout' => 'setEnforceAccountLockout', 'account_lockout_attempts' => 'setAccountLockoutAttempts', 'enforce_idle_timeout' => 'setEnforceIdleTimeout', 'idle_timeout_minutes' => 'setIdleTimeoutMinutes', 'enforce_two_factor_auth' => 'setEnforceTwoFactorAuth', 'enforce_login_ip_ranges' => 'setEnforceLoginIpRanges', 'login_ip_ranges' => 'setLoginIpRanges']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['enforce_password_expiration' => null, 'password_expiration_days' => null, 'enforce_different_passwords' => null, 'num_different_passwords' => null, 'enforce_strong_passwords' => null, 'enforce_account_lockout' => null, 'account_lockout_attempts' => null, 'enforce_idle_timeout' => null, 'idle_timeout_minutes' => null, 'enforce_two_factor_auth' => null, 'enforce_login_ip_ranges' => null, 'login_ip_ranges' => null]

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['enforce_password_expiration' => 'bool', 'password_expiration_days' => 'int', 'enforce_different_passwords' => 'bool', 'num_different_passwords' => 'int', 'enforce_strong_passwords' => 'bool', 'enforce_account_lockout' => 'bool', 'account_lockout_attempts' => 'int', 'enforce_idle_timeout' => 'bool', 'idle_timeout_minutes' => 'int', 'enforce_two_factor_auth' => 'bool', 'enforce_login_ip_ranges' => 'bool', 'login_ip_ranges' => '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 —

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> —

getEnforceDifferentPasswords()

Gets enforce_different_passwords

public getEnforceDifferentPasswords() : bool
Return values
bool —

getEnforcePasswordExpiration()

Gets enforce_password_expiration

public getEnforcePasswordExpiration() : bool
Return values
bool —

getLoginIpRanges()

Gets login_ip_ranges

public getLoginIpRanges() : array<string|int, string>
Return values
array<string|int, 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 —

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 —

setAccountLockoutAttempts()

Sets account_lockout_attempts

public setAccountLockoutAttempts(int $account_lockout_attempts) : $this
Parameters
$account_lockout_attempts : int

Number of consecutive failed login attempts after which users' accounts will be locked.

Return values
$this —

setEnforceAccountLockout()

Sets enforce_account_lockout

public setEnforceAccountLockout(bool $enforce_account_lockout) : $this
Parameters
$enforce_account_lockout : bool

Boolean indicating whether users' Dashboard accounts will be locked out after a specified number of consecutive failed login attempts.

Return values
$this —

setEnforceDifferentPasswords()

Sets enforce_different_passwords

public setEnforceDifferentPasswords(bool $enforce_different_passwords) : $this
Parameters
$enforce_different_passwords : bool

Boolean indicating whether users, when setting a new password, are forced to choose a new password that is different from any past passwords.

Return values
$this —

setEnforceIdleTimeout()

Sets enforce_idle_timeout

public setEnforceIdleTimeout(bool $enforce_idle_timeout) : $this
Parameters
$enforce_idle_timeout : bool

Boolean indicating whether users will be logged out after being idle for the specified number of minutes.

Return values
$this —

setEnforceLoginIpRanges()

Sets enforce_login_ip_ranges

public setEnforceLoginIpRanges(bool $enforce_login_ip_ranges) : $this
Parameters
$enforce_login_ip_ranges : bool

Boolean indicating whether organization will restrict access to Dashboard (including the API) from certain IP addresses.

Return values
$this —

setEnforcePasswordExpiration()

Sets enforce_password_expiration

public setEnforcePasswordExpiration(bool $enforce_password_expiration) : $this
Parameters
$enforce_password_expiration : bool

Boolean indicating whether users are forced to change their password every X number of days.

Return values
$this —

setEnforceStrongPasswords()

Sets enforce_strong_passwords

public setEnforceStrongPasswords(bool $enforce_strong_passwords) : $this
Parameters
$enforce_strong_passwords : bool

Boolean indicating whether users will be forced to choose strong passwords for their accounts. Strong passwords are at least 8 characters that contain 3 of the following: number, uppercase letter, lowercase letter, and symbol

Return values
$this —

setEnforceTwoFactorAuth()

Sets enforce_two_factor_auth

public setEnforceTwoFactorAuth(bool $enforce_two_factor_auth) : $this
Parameters
$enforce_two_factor_auth : bool

Boolean indicating whether users in this organization will be required to use an extra verification code when logging in to Dashboard. This code will be sent to their mobile phone via SMS, or can be generated by the Google Authenticator application.

Return values
$this —

setIdleTimeoutMinutes()

Sets idle_timeout_minutes

public setIdleTimeoutMinutes(int $idle_timeout_minutes) : $this
Parameters
$idle_timeout_minutes : int

Number of minutes users can remain idle before being logged out of their accounts.

Return values
$this —

setLoginIpRanges()

Sets login_ip_ranges

public setLoginIpRanges(array<string|int, string> $login_ip_ranges) : $this
Parameters
$login_ip_ranges : array<string|int, string>

List of acceptable IP ranges. Entries can be single IP addresses, IP address ranges, and CIDR subnets.

Return values
$this —

setNumDifferentPasswords()

Sets num_different_passwords

public setNumDifferentPasswords(int $num_different_passwords) : $this
Parameters
$num_different_passwords : int

Number of recent passwords that new password must be distinct from.

Return values
$this —

setPasswordExpirationDays()

Sets password_expiration_days

public setPasswordExpirationDays(int $password_expiration_days) : $this
Parameters
$password_expiration_days : int

Number of days after which users will be forced to change their password.

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

Search results