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: eJytVd9r2zAQ/leEnjYIcUj7MPK0UsoIrFtZ2r2UEBT5EqtRJFeSw4zx/7472U4c4hY2+hTr19333X3fpeI2ByeCsmae8hmX1sGq8OD8yoG0B3DlCvZC6ZV0IALwEU/BS6dyeoIPbuM2EyzAPrdOuJJpZXYsZCLgLoViUhj6YMGyNigeg3JMSGkLEzxGzYUTewiYmM+eK64o9muB6fHM4AkuGxw+iC3B8DLDDT6reChzOvbBKbPl9Yg7eC2UA+QTXAH1qA2Xi5Cdoql0KIgyAbbgKMo5zxtWGIWAWHuDHYSmVQomqE2JmZGT8uwJCY/5BYbliCNu4hZLzHHtQRZOhTLyFQVWBCPtcLWk2w58bo0HT+Cmk2v6OUe0KKQE7zeF1iXz+PhY3FgoonA9mdA7aRGzCfQp8lwrGfudvHiKU10Wwa5fQIaLVv8WWqXxKbtzzjrqmiP5BNXANNasNgp0ugI6972QwjlBrVQoEz/QNAQrbQrDJyJNFaUV+qGfD0+CChrOoDXI6vqigU09rj6wHt/AgFOS3TzM3yhICoE6MaTRt9melPPcBViemLZJ36GJW2ikzJKdc+tDNBcqf8YTkl4S3Z1UKq2Tc4snZAhwh86DhdP0SOQqOVwlvO5pdkElajj2lHtkk4WQd+6i9RqEI1MhNGU2Nt5s+ZyejzhlblhMJ9Pr8Zfx9KLm92JHVuteNZ1jXu1zDWQ7aq2QsbWNCxAMaG2/bu0x01hZ6gD2HdBgUbjNSLifP2KIhjZR8LMk2aqQFeuxtPukFyI5fa21XSeYyiTf57d3PxZ3kSYVfi9MLzjVPo5D3/m0bIzKhidrT6YfNmTb9gT4E5JcI2aqQ+RbtRppxxPuElL8ncU5eS4U3CBJZiQufFFVa+Hhyem6pu1mapOAUuXFWpOSN0J7eIfgp1+t6D+zt2DuoLz4D4gzOIp+SQunKN3/p/7XGT+Isxt4puwD7PBjNesl3spApOgIgtoc3OAwz0PvycVkIo5HYz/8XJBWSYY937U+G3UfFH4QD7Ys3ni0OzDYtg5eoDUhrOu/PDnNyg==
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 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>