first pass

This commit is contained in:
Tana M Berry
2024-10-22 15:10:13 -05:00
parent 63c3da169a
commit 7a6d44d0df
878 changed files with 474272 additions and 31 deletions

View File

@@ -0,0 +1,631 @@
---
id: core-users-retrieve
title: "core_users_retrieve"
description: "User Viewset"
sidebar_label: "core_users_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytV8Fu2zgQ/RWCl+0CXivrpMDCpw0aIzCQ7hZN0ksRCLQ0ltjQpEpSTr2G/r0zpGzLtuymi14SSRySb948Po7X3FRghZdGT3M+5pmxkNYOrEsteCthCXzAc3CZlRVFYcwjDrNPEl4ceByshBUL8DiFjz+vuaSQSvgShzQO4JvM8dllJSwEH6+5X1Xhq/ZQgOXN4frXrNbyaw2sjWBLoegtB+3lfCV1wXwpHSMcQ1zZwtdaWkD43tbQPA24FwWBCdlwfHeQ1Vb6VQAoal/SSs/49kTRFlxltANH4EYXF/QvM7i39vQoqkrJLFCUfHGEcH2cjJl9gcz3U3UPVgol/8NckS1LhHsZd6ueewghRCL/V6tVzAjzkV5RxPSG2KLyRGa3Ux2WShc4cyG+3YEukP3xn28vmk0JjgOPcf7mWC5dpcSK0aQhbSVdKjIvl90lZsYoEJrvYF3HkMNFb8DJQgsPjr2UgKTbWDfCz1xpapWzGTCP2XrImXAs7jVkj1gNhXzGeKmdR0KYmbMcP3sSgMgyU2vvAkolnE+VKaTuy3Ru7EJgJXmO2/zh5YKQ6lopMSP0QTMhU1djZQhcb7L7NcEZhTV15TqxwlqxwkjpYeHOIqlrPBLNdo0U1fOKdU5o7F4uUKBziRTe0nIdvTHcMdCNtW3hnlXgCaSnBRk3jOkQqYv0hKL3Id+CZ4JhOCLNhBrQSb8cselNAIxKiWj7WO/X82sKeKx4FFyeI23eRKGFTdmLVIp0uV0tigxtrjWEH5F1pK04NT11FA/JPZovPIbOag+9asAcJCUl1IduZRvS184aP0fmtkXaRzUgHTzt6krshNry5hX40AqlOstMjNitP6F3Yh+91+3b1ujtFaW8FF7YVxtXDB8wkMFmBCu9rxL6g9fExztm6Buef4Fv0z5Z/U+K0Yyx5D+sadAAJdej2/hhzQELQ2WiM4P2TmzBt+0jprmUGaSt75E7tHHp4dDT4AhNt6wPODahvQj8CfTnj/+hsNpa7bnZwXkc8J3MImeda6zFcSA/HgS8X23CfPVLL+hPaJR5mMom1prjG1obnaK3qjwFGv8Jvyf4mcn73Ko5LakdCTtoEdlJPi5/IR+3oMmT2fWH6QlCcvC9p/1stl25tAt0yt1ueiZN/IQtZmmoRS3arpPOE0+oxUuCSydrmTdJe1Y23WhtFUWJSibLy4Q3nWbwniiJOXVawi16Mo9N2xouEkC/tAGK1HMTIlv8u+kDTjtH1KOL0dXwr+HoiOP34jm0MO2sWCnm6BoH6meplNgJBVOIzspLUMr8XZjtTkNpQueDBx97pSDU2Gu/nz7QgQppB/8bJ0mBrljPhplZJJ0lkt3TTJlZglvp5G76bvLP/SSkWRnnF0J3FieyQz/h2KlfBx0lHv5QaIn1aGsJtpnYrTUt0nVbzrZjj95A98I4OAVppUQwFLBez4SDR6uahj7jzwRLbT0+LgW2PeFawrpjJ0vPqJe5UA7OgHzzsdXm7+xnf3j0JrQxB03WEBYgBQ/4M6ziT6HmCaNKdFTqUxBqHLjOMqh8Z8rRKSbtbg/B7YTKTBXs9jpRooPNA63eCwdJDBEP5hk0ErlB5+mdADbNdyg63XU=
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={"core_users_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/core/users/{id}/"}
>
</MethodEndpoint>
User 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":"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={"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={"ID (integer)"}
qualifierMessage={undefined}
schema={{"type":"integer","readOnly":true,"title":"ID"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"username"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `<= 150 characters`"}
schema={{"type":"string","maxLength":150}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"User's display name."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"is_active"}
required={false}
schemaName={"Active (boolean)"}
qualifierMessage={undefined}
schema={{"type":"boolean","title":"Active","description":"Designates whether this user should be treated as active. Unselect this instead of deleting accounts."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"last_login"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","nullable":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"is_superuser"}
required={true}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"groups"}
required={false}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
groups_obj
</strong><span
className={"openapi-schema__name"}
>
object[]
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__nullable"}
>
nullable
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Group uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"num_pk"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"Get a numerical, int32 ID for the group","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"is_superuser"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Users added to this group will be superusers."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"parent"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"parent_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true,"nullable":true}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
attributes
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","additionalProperties":{}}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</div>
</details>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"email"}
required={false}
schemaName={"email"}
qualifierMessage={"**Possible values:** `<= 254 characters`"}
schema={{"type":"string","format":"email","title":"Email address","maxLength":254}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"avatar"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"User's avatar, either a http/https URL or a data URI","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
attributes
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","additionalProperties":{}}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"uid"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"path"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"type"}
required={false}
schemaName={"UserTypeEnum (string)"}
qualifierMessage={"**Possible values:** [`internal`, `external`, `service_account`, `internal_service_account`]"}
schema={{"enum":["internal","external","service_account","internal_service_account"],"type":"string","title":"UserTypeEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"uuid"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": 0,\n \"username\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"last_login\": \"2024-07-29T15:51:28.071Z\",\n \"is_superuser\": true,\n \"groups\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"groups_obj\": [\n {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"num_pk\": 0,\n \"name\": \"string\",\n \"is_superuser\": true,\n \"parent\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"parent_name\": \"string\",\n \"attributes\": {}\n }\n ],\n \"email\": \"user@example.com\",\n \"avatar\": \"string\",\n \"attributes\": {},\n \"uid\": \"string\",\n \"path\": \"string\",\n \"type\": \"internal\",\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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>