AccountPasswordRules
in package
implements
ModelInterface, ArrayAccess
AccountPasswordRules Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- 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
- getExpirePassword() : string|null
- Gets expire_password
- getExpirePasswordDays() : string|null
- Gets expire_password_days
- getExpirePasswordDaysMetadata() : AccountPasswordExpirePasswordDays
- Gets expire_password_days_metadata
- getLockoutDurationMinutes() : string|null
- Gets lockout_duration_minutes
- getLockoutDurationMinutesMetadata() : AccountPasswordLockoutDurationMinutes
- Gets lockout_duration_minutes_metadata
- getLockoutDurationType() : string|null
- Gets lockout_duration_type
- getLockoutDurationTypeMetadata() : AccountPasswordLockoutDurationType
- Gets lockout_duration_type_metadata
- getMinimumPasswordAgeDays() : string|null
- Gets minimum_password_age_days
- getMinimumPasswordAgeDaysMetadata() : AccountPasswordMinimumPasswordAgeDays
- Gets minimum_password_age_days_metadata
- getMinimumPasswordLength() : string|null
- Gets minimum_password_length
- getMinimumPasswordLengthMetadata() : AccountMinimumPasswordLength
- Gets minimum_password_length_metadata
- getModelName() : string
- The original name of the model.
- getPasswordIncludeDigit() : string|null
- Gets password_include_digit
- getPasswordIncludeDigitOrSpecialCharacter() : string|null
- Gets password_include_digit_or_special_character
- getPasswordIncludeLowerCase() : string|null
- Gets password_include_lower_case
- getPasswordIncludeSpecialCharacter() : string|null
- Gets password_include_special_character
- getPasswordIncludeUpperCase() : string|null
- Gets password_include_upper_case
- getPasswordStrengthType() : string|null
- Gets password_strength_type
- getPasswordStrengthTypeMetadata() : AccountPasswordStrengthType
- Gets password_strength_type_metadata
- getQuestionsRequired() : string|null
- Gets questions_required
- getQuestionsRequiredMetadata() : AccountPasswordQuestionsRequired
- Gets questions_required_metadata
- 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.
- setExpirePassword() : $this
- Sets expire_password
- setExpirePasswordDays() : $this
- Sets expire_password_days
- setExpirePasswordDaysMetadata() : $this
- Sets expire_password_days_metadata
- setLockoutDurationMinutes() : $this
- Sets lockout_duration_minutes
- setLockoutDurationMinutesMetadata() : $this
- Sets lockout_duration_minutes_metadata
- setLockoutDurationType() : $this
- Sets lockout_duration_type
- setLockoutDurationTypeMetadata() : $this
- Sets lockout_duration_type_metadata
- setMinimumPasswordAgeDays() : $this
- Sets minimum_password_age_days
- setMinimumPasswordAgeDaysMetadata() : $this
- Sets minimum_password_age_days_metadata
- setMinimumPasswordLength() : $this
- Sets minimum_password_length
- setMinimumPasswordLengthMetadata() : $this
- Sets minimum_password_length_metadata
- setPasswordIncludeDigit() : $this
- Sets password_include_digit
- setPasswordIncludeDigitOrSpecialCharacter() : $this
- Sets password_include_digit_or_special_character
- setPasswordIncludeLowerCase() : $this
- Sets password_include_lower_case
- setPasswordIncludeSpecialCharacter() : $this
- Sets password_include_special_character
- setPasswordIncludeUpperCase() : $this
- Sets password_include_upper_case
- setPasswordStrengthType() : $this
- Sets password_strength_type
- setPasswordStrengthTypeMetadata() : $this
- Sets password_strength_type_metadata
- setQuestionsRequired() : $this
- Sets questions_required
- setQuestionsRequiredMetadata() : $this
- Sets questions_required_metadata
- 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
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
= ['expire_password' => 'expirePassword', 'expire_password_days' => 'expirePasswordDays', 'expire_password_days_metadata' => 'expirePasswordDaysMetadata', 'lockout_duration_minutes' => 'lockoutDurationMinutes', 'lockout_duration_minutes_metadata' => 'lockoutDurationMinutesMetadata', 'lockout_duration_type' => 'lockoutDurationType', 'lockout_duration_type_metadata' => 'lockoutDurationTypeMetadata', 'minimum_password_age_days' => 'minimumPasswordAgeDays', 'minimum_password_age_days_metadata' => 'minimumPasswordAgeDaysMetadata', 'minimum_password_length' => 'minimumPasswordLength', 'minimum_password_length_metadata' => 'minimumPasswordLengthMetadata', 'password_include_digit' => 'passwordIncludeDigit', 'password_include_digit_or_special_character' => 'passwordIncludeDigitOrSpecialCharacter', 'password_include_lower_case' => 'passwordIncludeLowerCase', 'password_include_special_character' => 'passwordIncludeSpecialCharacter', 'password_include_upper_case' => 'passwordIncludeUpperCase', 'password_strength_type' => 'passwordStrengthType', 'password_strength_type_metadata' => 'passwordStrengthTypeMetadata', 'questions_required' => 'questionsRequired', 'questions_required_metadata' => 'questionsRequiredMetadata']
$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
= ['expire_password' => 'getExpirePassword', 'expire_password_days' => 'getExpirePasswordDays', 'expire_password_days_metadata' => 'getExpirePasswordDaysMetadata', 'lockout_duration_minutes' => 'getLockoutDurationMinutes', 'lockout_duration_minutes_metadata' => 'getLockoutDurationMinutesMetadata', 'lockout_duration_type' => 'getLockoutDurationType', 'lockout_duration_type_metadata' => 'getLockoutDurationTypeMetadata', 'minimum_password_age_days' => 'getMinimumPasswordAgeDays', 'minimum_password_age_days_metadata' => 'getMinimumPasswordAgeDaysMetadata', 'minimum_password_length' => 'getMinimumPasswordLength', 'minimum_password_length_metadata' => 'getMinimumPasswordLengthMetadata', 'password_include_digit' => 'getPasswordIncludeDigit', 'password_include_digit_or_special_character' => 'getPasswordIncludeDigitOrSpecialCharacter', 'password_include_lower_case' => 'getPasswordIncludeLowerCase', 'password_include_special_character' => 'getPasswordIncludeSpecialCharacter', 'password_include_upper_case' => 'getPasswordIncludeUpperCase', 'password_strength_type' => 'getPasswordStrengthType', 'password_strength_type_metadata' => 'getPasswordStrengthTypeMetadata', 'questions_required' => 'getQuestionsRequired', 'questions_required_metadata' => 'getQuestionsRequiredMetadata']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['expire_password' => 'setExpirePassword', 'expire_password_days' => 'setExpirePasswordDays', 'expire_password_days_metadata' => 'setExpirePasswordDaysMetadata', 'lockout_duration_minutes' => 'setLockoutDurationMinutes', 'lockout_duration_minutes_metadata' => 'setLockoutDurationMinutesMetadata', 'lockout_duration_type' => 'setLockoutDurationType', 'lockout_duration_type_metadata' => 'setLockoutDurationTypeMetadata', 'minimum_password_age_days' => 'setMinimumPasswordAgeDays', 'minimum_password_age_days_metadata' => 'setMinimumPasswordAgeDaysMetadata', 'minimum_password_length' => 'setMinimumPasswordLength', 'minimum_password_length_metadata' => 'setMinimumPasswordLengthMetadata', 'password_include_digit' => 'setPasswordIncludeDigit', 'password_include_digit_or_special_character' => 'setPasswordIncludeDigitOrSpecialCharacter', 'password_include_lower_case' => 'setPasswordIncludeLowerCase', 'password_include_special_character' => 'setPasswordIncludeSpecialCharacter', 'password_include_upper_case' => 'setPasswordIncludeUpperCase', 'password_strength_type' => 'setPasswordStrengthType', 'password_strength_type_metadata' => 'setPasswordStrengthTypeMetadata', 'questions_required' => 'setQuestionsRequired', 'questions_required_metadata' => 'setQuestionsRequiredMetadata']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['expire_password' => null, 'expire_password_days' => null, 'expire_password_days_metadata' => null, 'lockout_duration_minutes' => null, 'lockout_duration_minutes_metadata' => null, 'lockout_duration_type' => null, 'lockout_duration_type_metadata' => null, 'minimum_password_age_days' => null, 'minimum_password_age_days_metadata' => null, 'minimum_password_length' => null, 'minimum_password_length_metadata' => null, 'password_include_digit' => null, 'password_include_digit_or_special_character' => null, 'password_include_lower_case' => null, 'password_include_special_character' => null, 'password_include_upper_case' => null, 'password_strength_type' => null, 'password_strength_type_metadata' => null, 'questions_required' => null, 'questions_required_metadata' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'accountPasswordRules'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['expire_password' => '?string', 'expire_password_days' => '?string', 'expire_password_days_metadata' => '\\DocuSign\\eSign\\Model\\AccountPasswordExpirePasswordDays', 'lockout_duration_minutes' => '?string', 'lockout_duration_minutes_metadata' => '\\DocuSign\\eSign\\Model\\AccountPasswordLockoutDurationMinutes', 'lockout_duration_type' => '?string', 'lockout_duration_type_metadata' => '\\DocuSign\\eSign\\Model\\AccountPasswordLockoutDurationType', 'minimum_password_age_days' => '?string', 'minimum_password_age_days_metadata' => '\\DocuSign\\eSign\\Model\\AccountPasswordMinimumPasswordAgeDays', 'minimum_password_length' => '?string', 'minimum_password_length_metadata' => '\\DocuSign\\eSign\\Model\\AccountMinimumPasswordLength', 'password_include_digit' => '?string', 'password_include_digit_or_special_character' => '?string', 'password_include_lower_case' => '?string', 'password_include_special_character' => '?string', 'password_include_upper_case' => '?string', 'password_strength_type' => '?string', 'password_strength_type_metadata' => '\\DocuSign\\eSign\\Model\\AccountPasswordStrengthType', 'questions_required' => '?string', 'questions_required_metadata' => '\\DocuSign\\eSign\\Model\\AccountPasswordQuestionsRequired']
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> —getExpirePassword()
Gets expire_password
public
getExpirePassword() : string|null
Return values
string|null —getExpirePasswordDays()
Gets expire_password_days
public
getExpirePasswordDays() : string|null
Return values
string|null —getExpirePasswordDaysMetadata()
Gets expire_password_days_metadata
public
getExpirePasswordDaysMetadata() : AccountPasswordExpirePasswordDays
Return values
AccountPasswordExpirePasswordDays —getLockoutDurationMinutes()
Gets lockout_duration_minutes
public
getLockoutDurationMinutes() : string|null
Return values
string|null —getLockoutDurationMinutesMetadata()
Gets lockout_duration_minutes_metadata
public
getLockoutDurationMinutesMetadata() : AccountPasswordLockoutDurationMinutes
Return values
AccountPasswordLockoutDurationMinutes —getLockoutDurationType()
Gets lockout_duration_type
public
getLockoutDurationType() : string|null
Return values
string|null —getLockoutDurationTypeMetadata()
Gets lockout_duration_type_metadata
public
getLockoutDurationTypeMetadata() : AccountPasswordLockoutDurationType
Return values
AccountPasswordLockoutDurationType —getMinimumPasswordAgeDays()
Gets minimum_password_age_days
public
getMinimumPasswordAgeDays() : string|null
Return values
string|null —getMinimumPasswordAgeDaysMetadata()
Gets minimum_password_age_days_metadata
public
getMinimumPasswordAgeDaysMetadata() : AccountPasswordMinimumPasswordAgeDays
Return values
AccountPasswordMinimumPasswordAgeDays —getMinimumPasswordLength()
Gets minimum_password_length
public
getMinimumPasswordLength() : string|null
Return values
string|null —getMinimumPasswordLengthMetadata()
Gets minimum_password_length_metadata
public
getMinimumPasswordLengthMetadata() : AccountMinimumPasswordLength
Return values
AccountMinimumPasswordLength —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPasswordIncludeDigit()
Gets password_include_digit
public
getPasswordIncludeDigit() : string|null
Return values
string|null —getPasswordIncludeDigitOrSpecialCharacter()
Gets password_include_digit_or_special_character
public
getPasswordIncludeDigitOrSpecialCharacter() : string|null
Return values
string|null —getPasswordIncludeLowerCase()
Gets password_include_lower_case
public
getPasswordIncludeLowerCase() : string|null
Return values
string|null —getPasswordIncludeSpecialCharacter()
Gets password_include_special_character
public
getPasswordIncludeSpecialCharacter() : string|null
Return values
string|null —getPasswordIncludeUpperCase()
Gets password_include_upper_case
public
getPasswordIncludeUpperCase() : string|null
Return values
string|null —getPasswordStrengthType()
Gets password_strength_type
public
getPasswordStrengthType() : string|null
Return values
string|null —getPasswordStrengthTypeMetadata()
Gets password_strength_type_metadata
public
getPasswordStrengthTypeMetadata() : AccountPasswordStrengthType
Return values
AccountPasswordStrengthType —getQuestionsRequired()
Gets questions_required
public
getQuestionsRequired() : string|null
Return values
string|null —getQuestionsRequiredMetadata()
Gets questions_required_metadata
public
getQuestionsRequiredMetadata() : AccountPasswordQuestionsRequired
Return values
AccountPasswordQuestionsRequired —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 —setExpirePassword()
Sets expire_password
public
setExpirePassword(string|null $expire_password) : $this
Parameters
- $expire_password : string|null
Return values
$this —setExpirePasswordDays()
Sets expire_password_days
public
setExpirePasswordDays(string|null $expire_password_days) : $this
Parameters
- $expire_password_days : string|null
Return values
$this —setExpirePasswordDaysMetadata()
Sets expire_password_days_metadata
public
setExpirePasswordDaysMetadata(AccountPasswordExpirePasswordDays $expire_password_days_metadata) : $this
Parameters
- $expire_password_days_metadata : AccountPasswordExpirePasswordDays
-
Metadata that indicates whether the
expirePasswordDays
property is editable.
Return values
$this —setLockoutDurationMinutes()
Sets lockout_duration_minutes
public
setLockoutDurationMinutes(string|null $lockout_duration_minutes) : $this
Parameters
- $lockout_duration_minutes : string|null
Return values
$this —setLockoutDurationMinutesMetadata()
Sets lockout_duration_minutes_metadata
public
setLockoutDurationMinutesMetadata(AccountPasswordLockoutDurationMinutes $lockout_duration_minutes_metadata) : $this
Parameters
- $lockout_duration_minutes_metadata : AccountPasswordLockoutDurationMinutes
-
Metadata that indicates whether the
lockoutDurationMinutes
property is editable.
Return values
$this —setLockoutDurationType()
Sets lockout_duration_type
public
setLockoutDurationType(string|null $lockout_duration_type) : $this
Parameters
- $lockout_duration_type : string|null
Return values
$this —setLockoutDurationTypeMetadata()
Sets lockout_duration_type_metadata
public
setLockoutDurationTypeMetadata(AccountPasswordLockoutDurationType $lockout_duration_type_metadata) : $this
Parameters
- $lockout_duration_type_metadata : AccountPasswordLockoutDurationType
-
Metadata that indicates whether the
lockoutDurationType
property is editable.
Return values
$this —setMinimumPasswordAgeDays()
Sets minimum_password_age_days
public
setMinimumPasswordAgeDays(string|null $minimum_password_age_days) : $this
Parameters
- $minimum_password_age_days : string|null
Return values
$this —setMinimumPasswordAgeDaysMetadata()
Sets minimum_password_age_days_metadata
public
setMinimumPasswordAgeDaysMetadata(AccountPasswordMinimumPasswordAgeDays $minimum_password_age_days_metadata) : $this
Parameters
- $minimum_password_age_days_metadata : AccountPasswordMinimumPasswordAgeDays
-
Metadata that indicates whether the
minimumPasswordAgeDays
property is editable.
Return values
$this —setMinimumPasswordLength()
Sets minimum_password_length
public
setMinimumPasswordLength(string|null $minimum_password_length) : $this
Parameters
- $minimum_password_length : string|null
Return values
$this —setMinimumPasswordLengthMetadata()
Sets minimum_password_length_metadata
public
setMinimumPasswordLengthMetadata(AccountMinimumPasswordLength $minimum_password_length_metadata) : $this
Parameters
- $minimum_password_length_metadata : AccountMinimumPasswordLength
-
Metadata that indicates whether the
minimumPasswordLength
property is editable.
Return values
$this —setPasswordIncludeDigit()
Sets password_include_digit
public
setPasswordIncludeDigit(string|null $password_include_digit) : $this
Parameters
- $password_include_digit : string|null
Return values
$this —setPasswordIncludeDigitOrSpecialCharacter()
Sets password_include_digit_or_special_character
public
setPasswordIncludeDigitOrSpecialCharacter(string|null $password_include_digit_or_special_character) : $this
Parameters
- $password_include_digit_or_special_character : string|null
Return values
$this —setPasswordIncludeLowerCase()
Sets password_include_lower_case
public
setPasswordIncludeLowerCase(string|null $password_include_lower_case) : $this
Parameters
- $password_include_lower_case : string|null
Return values
$this —setPasswordIncludeSpecialCharacter()
Sets password_include_special_character
public
setPasswordIncludeSpecialCharacter(string|null $password_include_special_character) : $this
Parameters
- $password_include_special_character : string|null
Return values
$this —setPasswordIncludeUpperCase()
Sets password_include_upper_case
public
setPasswordIncludeUpperCase(string|null $password_include_upper_case) : $this
Parameters
- $password_include_upper_case : string|null
Return values
$this —setPasswordStrengthType()
Sets password_strength_type
public
setPasswordStrengthType(string|null $password_strength_type) : $this
Parameters
- $password_strength_type : string|null
Return values
$this —setPasswordStrengthTypeMetadata()
Sets password_strength_type_metadata
public
setPasswordStrengthTypeMetadata(AccountPasswordStrengthType $password_strength_type_metadata) : $this
Parameters
- $password_strength_type_metadata : AccountPasswordStrengthType
-
Metadata that indicates whether the
passwordStrengthType
property is editable.
Return values
$this —setQuestionsRequired()
Sets questions_required
public
setQuestionsRequired(string|null $questions_required) : $this
Parameters
- $questions_required : string|null
Return values
$this —setQuestionsRequiredMetadata()
Sets questions_required_metadata
public
setQuestionsRequiredMetadata(AccountPasswordQuestionsRequired $questions_required_metadata) : $this
Parameters
- $questions_required_metadata : AccountPasswordQuestionsRequired
-
Metadata that indicates whether the
questionsRequired
property is editable.
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