---
id: policies-password-update
title: "policies_password_update"
description: "Password Policy Viewset"
sidebar_label: "policies_password_update"
hide_title: true
hide_table_of_contents: true
api: eJztWN9v2zYQ/lcIvWwDPMtNg7Xw09ou6wK0a5A23UMRCJR0tlhTpEpSdlzD//vuSMuSbdlZswLDtj4kkKXj/b7vI7mKdAWGO6HVZR6No0pLkQmwScWtXWiTJ3WVcwfRIMrBZkZUJIqCV5vv7IpWLNl7AQsLDuUqbngJDoyNxh9WkSDpirsCPyn80BhZJnUtcnxpswJKHo1XkVtW9Nk6I9QUv0y0KbnDN15yve/CM3Zzc/kLC+JM5KCcmCzp2RXCsj0Ph6jQwKdaGMBAnalhfTuIHJ+Sm9u4o9sgBdY91/mSvMq0cqiaHnlVoZjPVvzRkhOrQ/d1+hEyd2/C3oIRXIrPYChnhsrgyAFUFNJ0mI9SqFegppjK8SPMBtxBVpP2ROrplETaNanWErg68OKPAlRIj/avGD6B4qmEfMC4lGyrFCUmQTKUiy0Efk6BkTHIh+z5kuUw4bV0A6aVXLZLGRijjWXcbKWpetuWmgiQ+X0B7nv+Ky1iM1gypxnmPJsN2KR5Z8kVoSBnQrEro8vKYV/wKQQn+JwLSUF6P3ipa+WSXEyFsx03BNZ56stR8jtR1mU0Pnt0/uT86eOfzp9458LLUaujrrBsGbfw99RIvfgaauyyTLV8aEjSZz4phXqggmA+yQpuCAn+QgNTmyQlWIuVOpRHCV/nBCvpRJaYWoLt6fGtXMHnkIgkBVBJtVCQnxL+fJfNU9UvUYi0SnAasCx5klFuH5KS/Q7+TS9YyRU2sMCYcbaANSPBCm4LmsWNUepxHDUcJYpJUEQhIHQuOJ7YTBtIXGHAFnpnnB7s4OXEOxUMMG/A48OnmkumDcP0k9t8gyBzLmsYhDg6EDHBWcM5W3fh9kPANAJc4SR04DCg4XWAXFy1PkBpbCzEFSPc0vMJr9EgIv0Mf92uPVzbCuEqtMbZaPTPYHY1u5/ByFeev0GsDKF1shH0NzzXTwD/QsjPEIm1AtWLBrtuvgTHQhnYdhWzmvrNsQWwmcLxKfAPRwNy4Xzfbeu2m1i0PAeTagvJMS7dNX4NrjZqo+47bO3u6nu0J5WsDZdfbiSsu9cW7qV4Uuoc5JcFQzBgFBrwa9kx9SnCW5443QsgJwLYNgm2i9eBhenTfz/rf+P5/xbPf2P2/xWzbwGkC/eHsLVhtQEx5R489+Pp0c1C2CXsBkjpO/+q3P8eiT73S9kFdfPhKQ1Z2ANTErivo5Ibw5e4QDgobU/7e2bM+waDhjxHdkOzXF517a3bdLSuBc+O5uPxV8zHS1C4+8nYs6vLIwnJseKihwdPRtvtpI2CTuE3Rk+EGQiy0P7yog73D3S+iOLmSB83oxivOhcP65iuHsDMm3uK2khaxSsRzx/HEe0sm33nW0pRiLGz+9xGUzhXNfcYHm4Auch41yjJ1+11wsUdLysJ7Rm/JcGenV3YIu7zZ7tkj99GfWw16uOe0SGTjHZ5YXSI8h1Xd8G9/dCH6SGIoyje/dzgdnjXh9Sj4xhJxCTUJGxjNt3TFssjjA09czY6Ox8+HZ4ddPhrPqPLo2ZVmBNmBZVs6NFNOZ75QcKJoU6PCkAHf57qraWh0NTv2GagbLfQry/foYrQZNQwdhzHWLeiToeImnFHRdw+pVKnMZpS8avLFxe/v73wTVVp65BtOsqbVm9Zp//WrgMGJy7wNm3t4M7FlUTrFJH3fLUZrs59Wdug+DjevdmjSS7QWVqwWqXYezdGrtf0GkfC0HkOH+ccD1UpFQynMBfWn0yi8YRLCyf8//56gxw/sC+/COwNsQFvRdDtKZAQZhDhvnPv0nJ9S1sJ3OnimJPXQeJF8O3Hd6Sn1XAAuutBs+JZlkHlTsredvDt6oZ6KN3cS5YeUyPDF7Ttxv/e2XDG81jl360iydW0DpMaVHqSqamO7Q4pQNageaCgetOBZfQS7/QMFJayyY6j35SX9fpP0HXHbQ==
sidebar_class_name: "put 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_update"}
>
</Heading>

<MethodEndpoint
  method={"put"}
  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><strong
          className={"openapi-schema__required"}
        >
          required
        </strong>
      </summary><div
        style={{"textAlign":"left","marginLeft":"1rem"}}
      >
        
      </div><ul
        style={{"marginLeft":"1rem"}}
      >
        <SchemaItem
          collapsible={false}
          name={"name"}
          required={true}
          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>