---
id: policies-password-retrieve
title: "policies_password_retrieve"
description: "Password Policy Viewset"
sidebar_label: "policies_password_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytV99v2zYQ/lcIvWwDDCtLgrXw07ItywysW9A03UMRCJR0tlhTpEJSdlzD/3vvSElWbMVBsjwEkan78X13x7vTJtIVGO6EVtM8mkSVliITYJOKW7vSJk8MOCNgCdEoysFmRlQkjKLXjQS7Jp01+yxgZcGhXMUNL8GBsdHkyyYSJF1xV+ArhS9aN+ukrkWOhzYroOTRZBO5dUWvLbpUc3wz06bkDk+85HYfwgW7vZ3+wYI4EzkoJ2ZrenaFsGwP4RgNGrivhQGk6kwN27tR5PicYHbMIzyzkNVGuLWHz2tXkOEF/rojDQO20sqiKCI+PTmhf5lWDoXokVcVWvIhjb9awrk5ZKjTr5C5Z2N6A0ZwKb6BobAaypUTwXG1eD5ghJXn/yq5DnyRrXCSFBr7bVhDWvbN4Qt4wFAQuETq+ZwOd1Kp1hK4OiDxH4YrJED7I4ZPoHgqIR8xLiXrjKLELEiGgmArga9TYOQM8jH7bc1ymPFauhHTSGOnysAYbSzjppMmvJkuMTdNJvaD8xjmFTgW0sA6LWY14uGOrYAtlF6xAv+cZpALhy+AdXl7HFj0vASTagvJcCj3nX8EVxvVmPvBskfaz1hPKlkbLl/uJOg96wuvLk9KnYN8GRmBV8AodOB12VPmU12rPHG6Z5c0577GjxDoigTLxdvAxAzZ7zrXTIDMn0f/J4mxBawp0XhPs8WIzdozS/UnFOTIjl0brBOsEWwZECqPL7mQVNm++HiJsFySi7lwdpBeyR9EWZfR5PTn83fn789+OX+Hh0KFw5OdjbrCq55xC//PjNSrtzBj12Wq5WspSVBzVySlUK80ENwnWcENDZjBPkXdICnBWszNoITPbIK5cyJLTC3BDrSyTq7gS0hEkgKopFopyI8Jf3vIlqkalihEWiXY9DAReZJRNF8ThP2a/QvbUskVlqxAzr4ztWXPCm4LuiONU6pq7KjYMYmTIEaBEIILwBObaQOJK3CwFfrRlXk1wOnMgwoOmHfgx8B9jf1BG4bhJ9i8GRRLLnE6BR69STDD24U3a9uf2192DaTf7g/bVjPVRjQp99rzcD+9643HJphhTCKCg9WDwnf+prP/Mw763KuyS6rmg4mvcAr7xpSE2dczyY3ha1QQDko7UP5+MuZDF4MueY7TDd1yed33t92FYwctIHsyHmdvGI8rULj9ZOzievpEQHLMuBiYg0fZ9iupMdBLfOP0CM0wIAtN2/K8WXdxtZ1EcbtBxu1VjDe9PXcb06YLZtmuxbWRpMUrES/P4mjb2ztvKESBY2/77NgUzlXt2uzbDeAsMh6aULMwWBs+O3Vf8zawOD05PR+/H58exPwDX9D23GqFzDEryopG3Minlmc+tZhDin1UAPaZX+e68zQWmjKAxEGFwdMs/R+mn9BEoE0U7CSOcVIWdTrGexz3TMS7p1TqNEZXKv57+vvlPzeXnmalrcP+1zPeBn/XB5/6cOkV6JFvmCbUDh5cXEn0T5w89k2T8N4nw27pwMfJ448bqq4C4ZLCZpPiLL41crul4/saDH1j4OOS46KfUsqwMnJh/bYcTWZcWjiC/8ePTTX/xF7+LTRIsW0oitqJb8tU9aMId6G977btHY033L6w9Ah1kLjIMqhcT/egBVChdzfo6pJqgtLdH5+hnkftA1kfxIXx9BKf9AIUxrSF6eg3AdxuvwPJWS2h
sidebar_class_name: "get 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_retrieve"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  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><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>
      