Files
authentik/website/docs/developer-docs/api/reference/core-authenticated-sessions-retrieve.api.mdx
2024-09-13 12:17:54 -05:00

863 lines
37 KiB
Plaintext

---
id: core-authenticated-sessions-retrieve
title: "core_authenticated_sessions_retrieve"
description: "AuthenticatedSession Viewset"
sidebar_label: "core_authenticated_sessions_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJy9V0uP2zYQ/iuCTi3gWttNDoVPXSSLhYEmXdS7uSwMg5LGFtcUqZCUE9fQf88MRVmyJT+2CHoy5Xl+H4fD4S5UBWhmuZLTNJyEidKwYKXNQFqeMAvpwoAxKDYLDVZz2EA4ClMwieYFmaHRXVd/VqsHXzh8M2BRuWCa5WBBm3Dysgs5mRTMZiiSKMCvsuQpfpkkg5yFk11otwX9bzCgXKFkqXTObKNZ9RIInp+nH4NaPeApJbPc0tpm3AQH+QU+wTG61fC15BoQuNUlVPNRaNmKsnQ8hPhtICk1t1uXecPLGr/mpK3BFMgMGMr59uaGfhIlLSrRkhWFoKAYLXo1lOmuj1HFr5DY6zidgeZM8H9BE62ats7yOroj5hrmEI/2+XndWCkBTPZS+JBBsg74MvAVECCV3lpsA5ZYvoFG5shk6d9SbD2Zo7A0oBdsdRjsBNwHsAHWicH9IbOgNjsGmcKGJ3DZ2/PeReBNjj3FmskBvjDrJcs5gRgQ5SoFMSCpupX04n3vPTV2c1RT5k3Jo/px4ufSY69KD0u4PCHBc5hkpyWLU5ZHkFuoLocmYuP/0Nv8jbXRISTWCptKv/r/J1behppwesuLrvZl6rZ8f3o7NM0HTtgK1IIX152uB1DTx+Ajs6zHHrUsLg/3oiUjUaW0ephcwbo2ssxjtzn7ppOqMhbgNNUBDedUE9dvLzHmtEad3NtM67x8TORNlkIwcu54G+CRGXkdiXezz8MUHnrgeAWsEJ5zvVB6oACOs0JVCfab0usrdI+o8DFqHK2fa5BTgQ0nLpixh8XV3XaUDR7hvs75WynF6+03y3MYukDge4EQzdUOLrFE5DTX3/7wtEi7OXtmjk+g5ZbcD97OWKG9wYSIeP9T54IveP+nzjS411r1W6FUcrHkINIFkLzLHtOa0engFvIBVit32FMYlrA05RSWicduvKolpU2tzuwkH+9+Ih8PIHEoSoK7x+kJQlKwjA9d2+fQHvZm56Cz/T7oGZh0vYDNFM3UKz8F48Q7CSOaLKPhCTva0ZBWRXQDgN40A3OpBRmygkebd1FYdcbSGbHkO1A7nO4BZdYWzVztJj1gmk43ZsflUjlND6k1H4UUuQZye3P7fvzH+Pce7Z/YmsbrDg6qSMPzQsDYt2WcECkCbiPRH2YghPpzpfaRxly5RoEXH87Qrnbr58Cn6ROdPAebIJhJFK24zcp4nKg86riI2lUsVBxhKBn9Nf1w/3l272AWyticyY5z4j844L+ZYU1w6oXTqdZLjx3PvIXvNioEpkMQHZSdLwH/uBiFw0WAgol/D1HJZQiAbHa7mBl41qKq6O+vJdCV/ILLDcNHget6WCspN7TGslsyYeAMjl/+8SX+a/Bfn0+DWJteI6nTbJgo6QuXa9juXyE0GWXY7enuwaRr0V2SQGE7Rr22QJW/P1UP90+ew+5Tpi7wUbMg74MJIZ1O40mtQSKlTX6WvinBqvoBw5g7tg==
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 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_authenticated_sessions_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/core/authenticated_sessions/{uuid}/"}
>
</MethodEndpoint>
AuthenticatedSession 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":"uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Authenticated Session.","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={"uuid"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"current"}
required={true}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Check if session is currently active session","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"}
>
user_agent
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
Get parsed user agent
</div><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
device
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
User agent device
</div><SchemaItem
collapsible={false}
name={"brand"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"family"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"model"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
os
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
User agent os
</div><SchemaItem
collapsible={false}
name={"family"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"major"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"minor"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"patch"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"patch_minor"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
user_agent
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
User agent browser
</div><SchemaItem
collapsible={false}
name={"family"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"major"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"minor"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"patch"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"string"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
geo_ip
</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"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
Get GeoIP Data
</div><SchemaItem
collapsible={false}
name={"continent"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"country"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"lat"}
required={true}
schemaName={"double"}
qualifierMessage={undefined}
schema={{"type":"number","format":"double"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"long"}
required={true}
schemaName={"double"}
qualifierMessage={undefined}
schema={{"type":"number","format":"double"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"city"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
asn
</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"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
Get ASN Data
</div><SchemaItem
collapsible={false}
name={"asn"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"as_org"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","nullable":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"network"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","nullable":true}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"user"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"last_ip"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"last_user_agent"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"last_used"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"expires"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","nullable":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"current\": true,\n \"user_agent\": {\n \"device\": {\n \"brand\": \"string\",\n \"family\": \"string\",\n \"model\": \"string\"\n },\n \"os\": {\n \"family\": \"string\",\n \"major\": \"string\",\n \"minor\": \"string\",\n \"patch\": \"string\",\n \"patch_minor\": \"string\"\n },\n \"user_agent\": {\n \"family\": \"string\",\n \"major\": \"string\",\n \"minor\": \"string\",\n \"patch\": \"string\"\n },\n \"string\": \"string\"\n },\n \"geo_ip\": {\n \"continent\": \"string\",\n \"country\": \"string\",\n \"lat\": 0,\n \"long\": 0,\n \"city\": \"string\"\n },\n \"asn\": {\n \"asn\": 0,\n \"as_org\": \"string\",\n \"network\": \"string\"\n },\n \"user\": 0,\n \"last_ip\": \"string\",\n \"last_user_agent\": \"string\",\n \"last_used\": \"2024-09-13T14:05:42.110Z\",\n \"expires\": \"2024-09-13T14:05:42.110Z\"\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>