Step 1: Create the Password Policy

POST {{apiPath}}/environments/{{envID}}/passwordPolicies

The POST /environments/{{envID}}/passwordPolicies operation creates a password policy for the specified environment.

PropertyTypeRequired?
bypassPolicyBooleanOptional
defaultBooleanRequired
descriptionStringOptional
excludesCommonlyUsedBooleanRequired
excludesProfileDataBooleanRequired
history.countIntegerOptional
history.retentionDaysIntegerOptional
length.maxIntegerOptional
length.minIntegerOptional
lockout.durationSecondsIntegerOptional
lockout.failureCountIntegerOptional
maxAgeDaysIntegerOptional
maxRepeatedCharactersIntegerOptional
minAgeDaysIntegerOptional
minCharactersString[]Optional
minComplexityIntegerOptional
minUniqueCharactersIntegerOptional
nameStringRequired
notSimilarToCurrentBooleanRequired

See the Password policies data model for full property descriptions.

Request Body

{"name"=>"LDAP Gateway Policy", "description"=>"A policy for the external LDAP directory", "excludesProfileData"=>true, "notSimilarToCurrent"=>true, "excludesCommonlyUsed"=>true, "minComplexity"=>7, "maxAgeDays"=>182, "minAgeDays"=>1, "history"=>{"count"=>8, "retentionDays"=>365}, "lockout"=>{"failureCount"=>3, "durationSeconds"=>900}, "default"=>false}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring