Skip to main content

GetPasswordPolicy

Get the password policy for a given workspace

Description​

  • Get password policy information set for the specified workspace.
  • Not available to users without workspace access (403:Forbidden).

Method​

GET

Request URL Format​

/api/v0/workspaces/:workspace-id/password-policy

URL Params​

workspace-id Specifies the workspace ID to be acquired

Query Params​

None

Request URL Sample​

GET https://api.xxx.com/api/v0/workspaces/58ca3597cce5fe3ea0a42fa8/password-policy

Response Sample​

{
    "use_expired_day": false,　// Password expiration date availability
    "use_lockout_count": false,　// Availability of password lock
    "use_lockout_time": false,　// Password lock time availability
    "use_min_length": false,　　// Minimum password  length available
    "use_max_length": false,　　// Maximum password length available
    "use_pattern_check": false,　// Availability of password complexity check
    "use_same_limit": false,　// Availability of password failure count
    "expired_day": 30,  // Password expiration date
    "lockout_count": 5, // Number of failures before password is locked
    "lockout_time": 5, // Password lock time (minutes)
    "min_length": 6, // Minimum password length
    "max_length": 12, // Maximum password length
    "pattern_check_type": 0, // Password check pattern (Please see details below)
    "same_limit": 2
}

Password Check Pattern​

- 0: "Cannot use spaces in password."
- 1: "Must contain both letters and numbers."
- 2: "Must include alphanumeric and special characters (! Must contain either #$%-_=+<> or #$%-_=+<>.")
- 3: "Contains either alphanumeric characters or symbols."

Errors​

  • If the login user cannot use the specified workspace, a 403 error will occur.