Skip to main content

policies_password_list

GET 

/api/v3//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 objectrequired
    nextnumberrequired
    previousnumberrequired
    countnumberrequired
    currentnumberrequired
    total_pagesnumberrequired
    start_indexnumberrequired
    end_indexnumberrequired
    results object[]required
  • Array [
  • pkuuidrequired
    namestringrequired
    execution_loggingboolean

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

    componentstringrequired

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

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    bound_tointegerrequired

    Return objects policy is bound to

    password_fieldstring

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

    amount_digitsinteger

    Possible values: <= 2147483647

    amount_uppercaseinteger

    Possible values: <= 2147483647

    amount_lowercaseinteger

    Possible values: <= 2147483647

    amount_symbolsinteger

    Possible values: <= 2147483647

    length_mininteger

    Possible values: <= 2147483647

    symbol_charsetstring
    error_messagestring
    check_static_rulesboolean
    check_have_i_been_pwnedboolean
    check_zxcvbnboolean
    hibp_allowed_countinteger

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

    Possible values: <= 2147483647

    zxcvbn_score_thresholdinteger

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

    Possible values: <= 2147483647

  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/policies/password/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query