Password policy

Retrieve tenant password policy

Retrieve details of tenant password policy.

get

/tenant/password_policy

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/tenant/password_policy' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "min_length": 6,
  "max_length": 32,
  "contains_letters": true,
  "contains_numbers": true,
  "contains_special_letters": true,
  "disable_sequential_characters": true,
  "disable_repeating_characters": true,
  "disable_account_information": true
}

OK

Update tenant password policy

Update tenant password policy.

post

/tenant/password_policy

Authorizations

Body

min_lengthinteger · int32 · min: 6 · max: 32 · default: 6

The password must contains at least min_length characters.
Must be less than or equal the value of max_length.

max_lengthinteger · int32 · min: 6 · max: 32 · default: 32

The password must contains at most max_length characters.
Must be greater than or equal the value of min_length.

contains_lettersboolean · default: true

The password must contains at least one letter (latin characters).

contains_numbersboolean · default: true

The password must contains at least one number (0-9).

contains_special_lettersboolean · default: true

The password must contains at least one upper case letter or special character (e.g. ~,!,@,#,$,%,^,&,*,(,),_,+,=).

disable_sequential_charactersboolean · default: true

The password must not contains sequential_characters.

disable_repeating_charactersboolean · default: true

The password must not contains repeating_characters.

disable_account_informationboolean · default: true

The password must not similar to the account information.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/tenant/password_policy' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "min_length": 6,
    "max_length": 32,
    "contains_letters": true,
    "contains_numbers": true,
    "contains_special_letters": true,
    "disable_sequential_characters": true,
    "disable_repeating_characters": true,
    "disable_account_information": true
  }'

200

4XX

200

No body

OK