Skip to main content

policies_password_list

GET 
/policies/password/

Password Policy Viewset

Request​

Query Parameters

    amount_digits integer
    amount_lowercase integer
    amount_symbols integer
    amount_uppercase integer
    check_have_i_been_pwned boolean
    check_static_rules boolean
    check_zxcvbn boolean
    created date-time
    error_message string
    execution_logging boolean
    hibp_allowed_count integer
    last_updated date-time
    length_min integer
    name string
    ordering string

    Which field to use when ordering the results.

    page integer

    A page number within the paginated result set.

    page_size integer

    Number of results to return per page.

    password_field string
    policy_uuid uuid
    search string

    A search term.

    symbol_charset string
    zxcvbn_score_threshold integer

Responses​

Schema

    pagination

    object

    required

    next numberrequired
    previous numberrequired
    count numberrequired
    current numberrequired
    total_pages numberrequired
    start_index numberrequired
    end_index numberrequired

    results

    object[]

    required

  • Array [

    • pk uuidrequired
    name stringrequired
    execution_logging boolean

    When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged.

    component stringrequired

    Get object component so that we know how to edit the object

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    bound_to integerrequired

    Return objects policy is bound to

    password_field string

    Field key to check, field keys defined in Prompt stages are available.

    amount_digits integer

    Possible values: <= 2147483647

    amount_uppercase integer

    Possible values: <= 2147483647

    amount_lowercase integer

    Possible values: <= 2147483647

    amount_symbols integer

    Possible values: <= 2147483647

    length_min integer

    Possible values: <= 2147483647

    symbol_charset string
    error_message string
    check_static_rules boolean
    check_have_i_been_pwned boolean
    check_zxcvbn boolean
    hibp_allowed_count integer

    Possible values: <= 2147483647

    How many times the password hash is allowed to be on haveibeenpwned

    zxcvbn_score_threshold integer

    Possible values: <= 2147483647

    If the zxcvbn score is equal or less than this value, the policy will fail.

  • ]

Loading...