Site Home
API Reference
LoginTry for Free

Create Password Policy

post
https://{application_vanity_domain}/api/v1/password-policies
Query Params
boolean
Defaults to false

Boolean indicating if the operation should be treated as an upsert

Body Params

Password policy JSON object

string
string
enum
required
length between 1 and 30

[Required on Create and Upsert] The type of the owner of the resource.

Allowed:
string
required
length between 1 and 26

[Required on Create and Upsert] The ID of the owner of the resource.

integer
8 to 64

[Required on Create] The minimum number of characters required for a password to be valid.

boolean
Defaults to false

Boolean indicating whether the password is required to have at least 1 lowercase character (a-z).

boolean
Defaults to false

Boolean indicating whether the password is required to have at least 1 uppercase character (A-Z).

boolean
Defaults to false

Boolean indicating whether the password is required to have at least 1 digit (0-9).

boolean
Defaults to false

Boolean indicating whether the password is required to have at least 1 special character (!"#$%&'()*+,-./:;<=>?@[]^_`{|}~).

boolean
Defaults to false

Boolean indicating whether breached password detection is enabled.

string
enum
Defaults to NONE

The remediation strategy that will be used when a breached password is detected on login. Note, in order for the remediation strategy to be applied breachedPwdDetectionEnabled must be set to true

Supported Strategies:

  • NONE: No remediation strategy will be applied.
  • REQUIRE_PASSWORD_RESET: The user will be required to reset their password.
Allowed:
string
Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago