authentik/website/docs/developer-docs/api/reference/core-users-recovery-email-create.api.mdx

---
id: core-users-recovery-email-create
title: "core_users_recovery_email_create"
description: "Create a temporary link that a user can use to recover their accounts"
sidebar_label: "core_users_recovery_email_create"
hide_title: true
hide_table_of_contents: true
api: eJytVU1rGzEQ/StCpxaM101yKD41hFAMTRuapJdgjKwdexXLkiJpTZdl/3tntLv2GjuBlp68+pp5b+a9cc2tAy+ismaW8ymX1sOiDODDwoO0O/DVArZC6YX0ICLwEc8hSK8cPcEHN2mbCRZh66wXvmJamQ2LhYi4S6GYFIY+WLSsC4rHoDwTUtrSxIBRnfBiCxET8+lzzRXFfi0xPZ4ZPMFliyNEsSYYQRa4wac1j5Wj4xC9MmvejLiH11J5QD7Rl9CMunBOxOIQTeXngigTYQ2eohzzvGalUQiIdTfYTmha5WCiWlWYGTmpwJ6Q8JifYJiPOOImbqnEHNcBZOlVrBJfUWJFMNIGV3O67SE4awIEAncxuaKfY0QPpZQQwqrUumIBH++LmwpFFK4mE3onLWI2kT6Fc1rJ1O/sJVCc+rQIdvkCMp60+pfQKk9P2a331lPXPMknqhamsWaxUqDzBdB5GIQU3gtqpUKZhDNNQ7DS5nD+ROS5orRC3w/z4UlUUcMRtBZZ05w0sK3H5X+sx1cw4JVk1/ezNwqSQ6ROnNPo22wPynnuA8wPTLuk79DELTRSYcnOzoaYzIXKn/KMpJcld2e1ypvs2OIZGQL8rvdg6TU9Ek5lu8uMNwPNPlCJWo4D5e7ZFDG63l20XoLwZCqEpszKppsdn8PzEafMLYuLycXV+PP400nN78SGrNa/ajvHgto6DWQ7aq2QqbWtCxAMaG2/rO0+01hZ6gD2HdBgSbjtSLibPWKIljZRCNMsW6tYlMuxtNtsECI7fC21XWaYymTfZje33x9uE00q/FaYQXCqfRqHofdp1RqVnZ+sA5n+tyHbtSfC75g5jZipDolv3WmkG0+4S0jxd5rm5LFQcIMkWZC48EVdL0WAJ6+bhrbbqU0CylUQS01KXgkd4B2CH352ov/I3oK5gerkPyDN4CT6OS28onT/nvpvZ/xZnP3AM9UQYI8fq9nM8VYBIkdHENT24BqHuYuDJyeTiTjujX3/44G0SjIc+K7z2aj/oPBn8WDL0o1HuwGDbevhRVoTwqb5Azi9zck=
sidebar_class_name: "post 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 Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

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

<MethodEndpoint
  method={"post"}
  path={"/core/users/{id}/recovery_email/"}
>
  
</MethodEndpoint>



Create a temporary link that a user can use to recover their accounts

<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":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this User.","required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Query Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"email_stage","schema":{"type":"string"},"required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"204"}
        value={"204"}
      >
        <div>
          
          
          Successfully sent recover email
          
          
        </div><div>
          
        </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>