PATCH v1/PasswordSettings
User roles allowed to make this request:
DomainAdministrator
LocalDomainManager
GlobalDomainManager
Permissions required to make this request:
PasswordSetting.Write
PasswordSetting.Read
Patch the domain's password settings.
Request Information
URI Parameters
None.
Body Parameters
DomainPasswordSettings| Name | Description | Type | Additional information |
|---|---|---|---|
| AgeWarnThreshold |
Name of the password setting that determines warn when password expires in x days for a domain The valid values for the AgeWarnThreshold from 0 to 10 |
integer |
None. |
| EnforceTwoFactorAuthentication |
Name of the password setting that indicates if two-factor authentication is enforced for a domain |
boolean |
None. |
| MaxPasswordAge |
Name of the password setting that determines maximum password age in days for a domain The valid values for the maximum password age: 0, 30, 60, 90, 365 |
integer |
None. |
| MinCharsetsInPassword |
Name of the password setting that determines minimum char sets in password for a domain The default value for the minimum char sets in password is 4 This property cannot be updated |
integer |
None. |
| MinPasswordLength |
Name of the password setting that determines minimum password length for a domain The default value for the minimum password length is 12 This property cannot be updated |
integer |
None. |
| PasswordHistoryLength |
Name of the password setting that number of passwords kept in password history (new password must be different then these) for a domain The valid values for the password history Length from 0 to 10 |
integer |
None. |
Request Formats
application/json, text/json
{
"AgeWarnThreshold": 1,
"EnforceTwoFactorAuthentication": true,
"MaxPasswordAge": 1,
"MinCharsetsInPassword": 1,
"MinPasswordLength": 1,
"PasswordHistoryLength": 1
}
application/xml, text/xml
<DomainPasswordSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <AgeWarnThreshold>1</AgeWarnThreshold> <EnforceTwoFactorAuthentication>true</EnforceTwoFactorAuthentication> <MaxPasswordAge>1</MaxPasswordAge> <MinCharsetsInPassword>1</MinCharsetsInPassword> <MinPasswordLength>1</MinPasswordLength> <PasswordHistoryLength>1</PasswordHistoryLength> </DomainPasswordSettings>
application/x-www-form-urlencoded
AgeWarnThreshold=1&EnforceTwoFactorAuthentication=true&MaxPasswordAge=1&MinCharsetsInPassword=1&MinPasswordLength=1&PasswordHistoryLength=1
multipart/form-data
Sample not available.
Response Information
Resource Description
Response Message
DomainPasswordSettings| Name | Description | Type | Additional information |
|---|---|---|---|
| AgeWarnThreshold |
Name of the password setting that determines warn when password expires in x days for a domain The valid values for the AgeWarnThreshold from 0 to 10 |
integer |
None. |
| EnforceTwoFactorAuthentication |
Name of the password setting that indicates if two-factor authentication is enforced for a domain |
boolean |
None. |
| MaxPasswordAge |
Name of the password setting that determines maximum password age in days for a domain The valid values for the maximum password age: 0, 30, 60, 90, 365 |
integer |
None. |
| MinCharsetsInPassword |
Name of the password setting that determines minimum char sets in password for a domain The default value for the minimum char sets in password is 4 This property cannot be updated |
integer |
None. |
| MinPasswordLength |
Name of the password setting that determines minimum password length for a domain The default value for the minimum password length is 12 This property cannot be updated |
integer |
None. |
| PasswordHistoryLength |
Name of the password setting that number of passwords kept in password history (new password must be different then these) for a domain The valid values for the password history Length from 0 to 10 |
integer |
None. |
Response Formats
application/json, text/json
{
"AgeWarnThreshold": 1,
"EnforceTwoFactorAuthentication": true,
"MaxPasswordAge": 1,
"MinCharsetsInPassword": 1,
"MinPasswordLength": 1,
"PasswordHistoryLength": 1
}
application/xml, text/xml
<DomainPasswordSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <AgeWarnThreshold>1</AgeWarnThreshold> <EnforceTwoFactorAuthentication>true</EnforceTwoFactorAuthentication> <MaxPasswordAge>1</MaxPasswordAge> <MinCharsetsInPassword>1</MinCharsetsInPassword> <MinPasswordLength>1</MinPasswordLength> <PasswordHistoryLength>1</PasswordHistoryLength> </DomainPasswordSettings>