Password policy

Retrieve tenant password policy

get

Retrieve details of tenant password policy.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

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

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

Default: 6

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

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

Default: 32

contains_lettersbooleanOptional

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

Default: true

contains_numbersbooleanOptional

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

Default: true

contains_special_lettersbooleanOptional

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

Default: true

disable_sequential_charactersbooleanOptional

The password must not contains sequential_characters.

Default: true

disable_repeating_charactersbooleanOptional

The password must not contains repeating_characters.

Default: true

disable_account_informationbooleanOptional

The password must not similar to the account information.

Default: true

4XX

Error

get/tenant/password_policy

GET /api/tenant/password_policy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
}

Update tenant password policy

post

Update tenant password policy.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

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

Default: 6

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

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

Default: 32

contains_lettersbooleanOptional

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

Default: true

contains_numbersbooleanOptional

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

Default: true

contains_special_lettersbooleanOptional

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

Default: true

disable_sequential_charactersbooleanOptional

The password must not contains sequential_characters.

Default: true

disable_repeating_charactersbooleanOptional

The password must not contains repeating_characters.

Default: true

disable_account_informationbooleanOptional

The password must not similar to the account information.

Default: true

Responses

200

OK

No content

4XX

Error

post/tenant/password_policy

POST /api/tenant/password_policy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "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
}

No content