GET v1/PasswordSettings

User roles allowed to make this request: DomainAdministrator LocalDomainManager GlobalDomainManager DemoUser

Permissions required to make this request: PasswordSetting.Read

Gets all password settings for the domain.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Response Message

DomainPasswordSettings
NameDescriptionTypeAdditional 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 valid values for the minimum char sets in password from 0 to 4

integer

None.

MinPasswordLength

Name of the password setting that determines minimum password length for a domain The valid values for the minimum password length: 0, 6, 8, 12

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

Sample:
{
  "AgeWarnThreshold": 1,
  "EnforceTwoFactorAuthentication": true,
  "MaxPasswordAge": 1,
  "MinCharsetsInPassword": 1,
  "MinPasswordLength": 1,
  "PasswordHistoryLength": 1
}

application/xml, text/xml

Sample:
<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>