Files
authentik/website/docs/developer-docs/api/reference/core-users-impersonate-create.api.mdx
2024-09-13 12:17:54 -05:00

289 lines
9.2 KiB
Plaintext

---
id: core-users-impersonate-create
title: "core_users_impersonate_create"
description: "Impersonate a user"
sidebar_label: "core_users_impersonate_create"
hide_title: true
hide_table_of_contents: true
api: eJytVEtrGzEQ/itCpxaM5SY5FJ8aSiiGpg110kswRrs79iqWpY00a2qW/e+d0a7jTe0GCj3pMe9vvplG+gqCRuPdrJBTmfsAyzpCiEuzJUn0TiMs8wB0yJEsIObBVKxP2rOjitCCzUil0kFvAUkgp4+NNKxYaSxJ5EhAL1PQPeYlbLWcNhL3Vfp1CGvy0P4Z5VrUzjzXIHoNsdOWXwU4NKu9cWuBpYnigeKPyXOA59oEoHIw1NAuRhL1mpNJ1Ul6R8jrYHCfEtQ1luxpQ68FaweIlXcRIid3Mbni43VG8zrPIcZVbe1eRNQBoRBHvFiJqriaTNg095S2Q77qqrImTwrqKbKr5hQHnz1BjidY/9TWFMlU3ITgE9KBm4emy9R5t1wZsMUSWB4HLnUIek8GBmE7/I8YCD3ZUrK5L+C8RBeF4bDa3g3jkQQNWniVWpdZ2570sMPjwymU1wlJQb001LGkdfkfUfsCDoLJxfXd7C+wFYDa2DOlv4XJkWKPBweLIx590DfAoC8akdLzyFU+YhobGpGpVMxRlSZQNaZo1WAMFY8NhN1htOpg2UJXRu0ulWwHzJ4zPl2BA36/lFIiVocZ5HcGOvDoUV7GrXzS7Is5mo8kR+5KuJhcXI0/jj+cAH6rNzyQB6uubSJSFRZ4OLmvOk99pQYy8LIEa/2ntX+JNDae4aemA41h4na3OG5n9+SiK5tLiFOl1gbLOhvnfqsGLtTxllmfKQrl1NfZ55tv85tUJqO+1W7gnIFPOywORhnE+dU3IOj5LdgDjfALVWUpOleUMm/6VvfriH45Jp3TtBcHsenFtCqZIKTeNJmO8BBs2/I3bcTAG4yuOx2MzrhdxIrCRL4TtVbaRngj8Xc/ehq/F/+6Y8+Wd9g2jndNcsBkH8kN7Lut3y5IqwRdEEScaifgFVDhwORk4JnZL/Ny933OLOAGDxjdM3h0uLD7s/kQiknj3m/AEZKH9JDfnGHb/gY2tHKK
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_impersonate_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/core/users/{id}/impersonate/"}
>
</MethodEndpoint>
Impersonate a user
<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><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"204"}
value={"204"}
>
<div>
Successfully started impersonation
</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={"401"}
value={"401"}
>
<div>
Access denied
</div><div>
</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>