Set the password settings

PUT /api/2.0/settings/security/password

Request

Sets the portal password settings.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Password settings

minLengthintegerformat: int32

Minimum password length

upperCaseboolean

Specifies if the password must include the uppercase letters or not

digitsboolean

Specifies if the password must include the digits or not

specSymbolsboolean

Specifies if the password must include the special symbols or not

Examples

PUT /api/2.0/settings/security/password HTTP/1.1
Accept: application/json
Content-Length: 85
Content-Type: application/json
Host: example.com

{
  "minLength": 1234,
  "upperCase": true,
  "digits": true,
  "specSymbols": true
}
curl --request PUT \
  --url https://example.com/api/2.0/settings/security/password \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "minLength": 1234,
  "upperCase": true,
  "digits": true,
  "specSymbols": true
}'

Responses

200

Password settings

minLengthintegerformat: int32

Min length

upperCaseboolean

Upper case

digitsboolean

Digits

specSymbolsboolean

Spec symbols

allowedCharactersRegexStrstring

Allowed characters regex str

digitsRegexStrstring

Digits regex str

upperCaseRegexStrstring

Upper case regex str

specSymbolsRegexStrstring

Spec symbols regex str

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).