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

200

application/json

Schema

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.

]

Example (from schema)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "execution_logging": true,
      "component": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string",
      "bound_to": 0,
      "password_field": "string",
      "amount_digits": 0,
      "amount_uppercase": 0,
      "amount_lowercase": 0,
      "amount_symbols": 0,
      "length_min": 0,
      "symbol_charset": "string",
      "error_message": "string",
      "check_static_rules": true,
      "check_have_i_been_pwned": true,
      "check_zxcvbn": true,
      "hibp_allowed_count": 0,
      "zxcvbn_score_threshold": 0
    }
  ]
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

Loading...