Get Password Policy
    • Dark
      Light
    • PDF

    Get Password Policy

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/pw.getPolicy

    Get the current password policy for users in your workspace.

    Header parameters
    X-User-Id
    stringRequired

    The user ID.

    ExampleCkCPNctrgCDfmWLqC
    X-Auth-Token
    stringRequired

    The authentication token.

    Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
    Responses
    200

    OK

    Success
    {
      "enabled": true,
      "policy": [
        [
          "get-password-policy-minLength",
          {
            "minLength": 7
          }
        ],
        [
          "get-password-policy-forbidRepeatingCharacters"
        ],
        [
          "get-password-policy-forbidRepeatingCharactersCount",
          {
            "forbidRepeatingCharactersCount": 3
          }
        ],
        [
          "get-password-policy-mustContainAtLeastOneLowercase"
        ],
        [
          "get-password-policy-mustContainAtLeastOneUppercase"
        ],
        [
          "get-password-policy-mustContainAtLeastOneNumber"
        ],
        [
          "get-password-policy-mustContainAtLeastOneSpecialCharacter"
        ]
      ],
      "success": true
    }
    object

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.