Skip to main content

Gets a user password settings

GET 
/api/web/v1/users/:userid/settings/password

Get password settings information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.

Request​

Path Parameters

    userid stringrequired

    The UUID of the user whose password settings information is to be fetched.

Responses​

Successful

Schema

    adComplexity boolean

    A boolean flag indication if adComplexitiy is enabled.

    includeLowercase string

    Possible values: [REQUIRED, ALLOWED, NOT_ALLOWED]

    includeLowercase

    includeNonalphanumeric string

    Possible values: [REQUIRED, ALLOWED, NOT_ALLOWED]

    includeNonalphanumeric

    includeNumber string

    Possible values: [REQUIRED, ALLOWED, NOT_ALLOWED]

    includeNumber

    includeUppercase string

    Possible values: [REQUIRED, ALLOWED, NOT_ALLOWED]

    includeUppercase

    lifetimeDays int32

    lifetimeDays

    maximumRepeated int32

    Maximum number of repeated characters allowed

    minimumLength int32

    minimumLength

    minimumLifetime int32

    minimumLifetime

    minimumStrength int32

    Possible values: <= 4

    Minimum password strength. Password set/update will be rejected, if strength of the password is less than this value. 0: Disabled, 1: Weak protection from throttled online attacks: very guessable, 3: Good protection from offline attacks: safely unguessable, 4: Strong protection from offline attacks: very unguessable

    numberOfLowercaseRequired int32

    Number of lower case characters required.

    numberOfNonalphanumericRequired int32

    Required number of non alpha numeric characters required.

    numberOfNumericRequired int32

    Number of numeric characters required.

    numberOfUppercaseRequired int32

    Number of upper case characters required.

    passwordHistorySize int32

    Size of password history for a user.

Loading...