---
id: policies-password-partial-update
title: "policies_password_partial_update"
description: "Password Policy Viewset"
sidebar_label: "policies_password_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJztWF9v2zYQ/yqEXrYBnuWmwVr4aWmXtQHaLUjS7qEIBEo6W6wpUiUpO67h77470rJkW3HWrMCwog8JaOrueH9/d+Qq0hUY7oRWF3k0jiotRSbAJhW3dqFNjgvjBJdJXeXcQTSIcrCZERWxIMPlho5dEueSvRewsOCQDhl5CQ6MjcYfVpEg6oq7Aj8p/NActkzqWuS4abMCSh6NV5FbVvTZOiPUFL9MtCm5wx1Pud5X4Yy9e3fxGwvkTOSgnJgsae0KYdmehkMUaOBTLQygwc7UsL4dRI5PSc2t/dFtoALrXuh8SVplWjkUTUteVUjmvRZ/tKTE6lB9nX6EzD3osGsw6F7xGQz5zFA4HCmAgoKbDv1RCvUG1BRdOX6C3oA7yGqSnkg9nRJJy5NqLYGrAy3+KkAF92i/xXAFiqcS8gHjUrKtUKSYBMoQLrYQ+DkFRodBPmQvliyHCa+lGzCt5LJlZWCMNpZxs6Wm6G1TayJA5g8ZuK/578TEZrBkTjP0eTYbsEmzZ0kVoSBnQrFLo8vKYV7wKQQl+JwLSUZ6PXipa+WSXEyFsx01BMZ56sNR8jtR1mU0Pnly+uz0+dNfTp955cLmqJVRVxi2jFv4d2KkXnwNMXZZplo+1iTpPZ+UQj1SQDg+yQpuCAn+QQJTmiQlWIuROqRHCh/nBCPpRJaYWoLtyfEtXcHnkIgkBVBJtVCQHyP+fJfNU9VPUYi0SrAaMCx5kpFvH+OS/Qx+rRes5AoTWKDNWFvAmpJgBbcF1eLmUMpxLDUsJbJJkEXBIFQuKJ7YTBtIXGHAFnqnnB6t4MXEKxUOYP4Ajw+fai6ZNgzdT2rzDYLMuaxhEOzoQMQEaw3rDDV1wknw0OfQ53mDgAEArwLKIiGRWoQOI9zStwxeo0wE8xn+ul17RLYVIlKI/slo9N/AcjV7uEmRrjz/E+Ew9JiOE4L8ppX1Y/z/ENUzBFutQPUW/K6ar8CxEAa25WJWU0o5tgA2U1ghBf5h9kMunE+tbdx2HYsnz8Gk2kJyX7vcPfwKXG3URtwPmL1d7gekJ5WsDZdffkjge/AsHJd4Uuoc5JcZQ5VuFB7gedl94lNEsDxxuhcjjhiwTRJMFy8DA9Mn/+HG/r2Vf1ut/Hvz/uabd3tX+tACSBfuD2Fr09UG1Cn34LkfT2+7M0J3OIj8ULBrILnv9Kv2/vfY6HPPys4pmw8vYtiFPTAlofd1RHJj+BIZhIPS9qS/74x5X2FQkefY3fBYLi+753VGpla1oNm9/nj6Ff3xChROPxk7u7y4xyE5Rlz09MGj1nYzaSOgE/jNoUfMDA2y0Hl4SMgK/8hAl4gobu7tcVOM8arzurCO6X0BzLx5jKiNJC5eiXj+NI5otmwmz2tyUrCyM39u7Smcq5rHCg84gN3IeOXIzVftm8H5HS8rCe1Fvm2DPbNdGBL3O2jLstfhRn39atTXfUaHvWS02xlGhzjfUXUX3tsPfagejLgXx7ufG+QOe31YPbofJak1CTUJg8wmf9pgeYyxIWtORienw+fDk4Mcf8tn9ELUcIVKYVZQyIYe35TjmS8lrBnK9agAVPDXqd6eNBSaMh7TDJTtBvrtxQ2KCElGCWPHcYxxK+p0iLgZd0TE7SqVOo3xKBW/uXh5/sf1uU+qSluH/aYjvEn1tu9snuhY/xNdBxaOvNZt0tvBnYsriVqQZd6C1abIOo9jbaLicrz7jEc1XaDSxLBapZiD74xcr2kbS8PQzQ6Xc47Xq5QCh9WYC+vvKNF4wqWFI/r/eLXBkJ/Yl7/69ZrYwLgiEPfNkLBmEOEEuvdCub6loQJnXix30jpQvAy6/XxDcloJB/C7HjQcZ1kGlTtKe9tBusuzm5evIxrewzNk6fE1MnxBIzj+9+qG+55HLb+3iiRX0zrUbBDqG05NkWynpQBeg2ZBZvU6BAPpKW70DBQGs/GPo9/kmfX6byvxxTo=
sidebar_class_name: "patch api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"policies_password_partial_update"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/policies/password/{policy_uuid}/"}
>
  
</MethodEndpoint>



Password Policy Viewset

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Path Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"path","name":"policy_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Password Policy.","required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><MimeTabs
  className={"openapi-tabs__mime"}
>
  <TabItem
    label={"application/json"}
    value={"application/json-schema"}
  >
    <details
      style={{}}
      className={"openapi-markdown__details mime"}
      data-collapsed={false}
      open={true}
    >
      <summary
        style={{}}
        className={"openapi-markdown__details-summary-mime"}
      >
        <h3
          className={"openapi-markdown__details-summary-header-body"}
        >
          Body
        </h3>
      </summary><div
        style={{"textAlign":"left","marginLeft":"1rem"}}
      >
        
      </div><ul
        style={{"marginLeft":"1rem"}}
      >
        <SchemaItem
          collapsible={false}
          name={"name"}
          required={false}
          schemaName={"string"}
          qualifierMessage={"**Possible values:** `non-empty`"}
          schema={{"type":"string","minLength":1}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"execution_logging"}
          required={false}
          schemaName={"boolean"}
          qualifierMessage={undefined}
          schema={{"type":"boolean","description":"When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged."}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"password_field"}
          required={false}
          schemaName={"string"}
          qualifierMessage={"**Possible values:** `non-empty`"}
          schema={{"type":"string","minLength":1,"description":"Field key to check, field keys defined in Prompt stages are available."}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"amount_digits"}
          required={false}
          schemaName={"integer"}
          qualifierMessage={"**Possible values:** `<= 2147483647`"}
          schema={{"type":"integer","maximum":2147483647,"minimum":0}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"amount_uppercase"}
          required={false}
          schemaName={"integer"}
          qualifierMessage={"**Possible values:** `<= 2147483647`"}
          schema={{"type":"integer","maximum":2147483647,"minimum":0}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"amount_lowercase"}
          required={false}
          schemaName={"integer"}
          qualifierMessage={"**Possible values:** `<= 2147483647`"}
          schema={{"type":"integer","maximum":2147483647,"minimum":0}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"amount_symbols"}
          required={false}
          schemaName={"integer"}
          qualifierMessage={"**Possible values:** `<= 2147483647`"}
          schema={{"type":"integer","maximum":2147483647,"minimum":0}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"length_min"}
          required={false}
          schemaName={"integer"}
          qualifierMessage={"**Possible values:** `<= 2147483647`"}
          schema={{"type":"integer","maximum":2147483647,"minimum":0}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"symbol_charset"}
          required={false}
          schemaName={"string"}
          qualifierMessage={"**Possible values:** `non-empty`"}
          schema={{"type":"string","minLength":1}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"error_message"}
          required={false}
          schemaName={"string"}
          qualifierMessage={undefined}
          schema={{"type":"string"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"check_static_rules"}
          required={false}
          schemaName={"boolean"}
          qualifierMessage={undefined}
          schema={{"type":"boolean"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"check_have_i_been_pwned"}
          required={false}
          schemaName={"boolean"}
          qualifierMessage={undefined}
          schema={{"type":"boolean"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"check_zxcvbn"}
          required={false}
          schemaName={"boolean"}
          qualifierMessage={undefined}
          schema={{"type":"boolean"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"hibp_allowed_count"}
          required={false}
          schemaName={"integer"}
          qualifierMessage={"**Possible values:** `<= 2147483647`"}
          schema={{"type":"integer","maximum":2147483647,"minimum":0,"description":"How many times the password hash is allowed to be on haveibeenpwned"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"zxcvbn_score_threshold"}
          required={false}
          schemaName={"integer"}
          qualifierMessage={"**Possible values:** `<= 2147483647`"}
          schema={{"type":"integer","maximum":2147483647,"minimum":0,"description":"If the zxcvbn score is equal or less than this value, the policy will fail."}}
        >
          
        </SchemaItem>
      </ul>
    </details>
  </TabItem>
</MimeTabs><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"pk"}
                        required={true}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","readOnly":true,"title":"Policy uuid"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"execution_logging"}
                        required={false}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean","description":"When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"component"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name_plural"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"meta_model_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return internal model name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"bound_to"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer","description":"Return objects policy is bound to","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"password_field"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Field key to check, field keys defined in Prompt stages are available."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"amount_digits"}
                        required={false}
                        schemaName={"integer"}
                        qualifierMessage={"**Possible values:** `<= 2147483647`"}
                        schema={{"type":"integer","maximum":2147483647,"minimum":0}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"amount_uppercase"}
                        required={false}
                        schemaName={"integer"}
                        qualifierMessage={"**Possible values:** `<= 2147483647`"}
                        schema={{"type":"integer","maximum":2147483647,"minimum":0}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"amount_lowercase"}
                        required={false}
                        schemaName={"integer"}
                        qualifierMessage={"**Possible values:** `<= 2147483647`"}
                        schema={{"type":"integer","maximum":2147483647,"minimum":0}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"amount_symbols"}
                        required={false}
                        schemaName={"integer"}
                        qualifierMessage={"**Possible values:** `<= 2147483647`"}
                        schema={{"type":"integer","maximum":2147483647,"minimum":0}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"length_min"}
                        required={false}
                        schemaName={"integer"}
                        qualifierMessage={"**Possible values:** `<= 2147483647`"}
                        schema={{"type":"integer","maximum":2147483647,"minimum":0}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"symbol_charset"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"error_message"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"check_static_rules"}
                        required={false}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"check_have_i_been_pwned"}
                        required={false}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"check_zxcvbn"}
                        required={false}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"hibp_allowed_count"}
                        required={false}
                        schemaName={"integer"}
                        qualifierMessage={"**Possible values:** `<= 2147483647`"}
                        schema={{"type":"integer","maximum":2147483647,"minimum":0,"description":"How many times the password hash is allowed to be on haveibeenpwned"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"zxcvbn_score_threshold"}
                        required={false}
                        schemaName={"integer"}
                        qualifierMessage={"**Possible values:** `<= 2147483647`"}
                        schema={{"type":"integer","maximum":2147483647,"minimum":0,"description":"If the zxcvbn score is equal or less than this value, the policy will fail."}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"name\": \"string\",\n  \"execution_logging\": true,\n  \"component\": \"string\",\n  \"verbose_name\": \"string\",\n  \"verbose_name_plural\": \"string\",\n  \"meta_model_name\": \"string\",\n  \"bound_to\": 0,\n  \"password_field\": \"string\",\n  \"amount_digits\": 0,\n  \"amount_uppercase\": 0,\n  \"amount_lowercase\": 0,\n  \"amount_symbols\": 0,\n  \"length_min\": 0,\n  \"symbol_charset\": \"string\",\n  \"error_message\": \"string\",\n  \"check_static_rules\": true,\n  \"check_have_i_been_pwned\": true,\n  \"check_zxcvbn\": true,\n  \"hibp_allowed_count\": 0,\n  \"zxcvbn_score_threshold\": 0\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>
      