eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-26 17:45:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

first pass

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

371
website/docs/developer-docs/api/reference/enterprise-license-summary-retrieve.api.mdx Normal file
View File

@@ -0,0 +1,371 @@
---
id: enterprise-license-summary-retrieve
title: "enterprise_license_summary_retrieve"
description: "Get the total license status"
sidebar_label: "enterprise_license_summary_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVcFu2zAM/RVD5ywu0h6GnDYMWRGgHQqk22UoDMVmYjWy5Ep0UC/wv4+UndhpkvbSky1LJB8fn592wpbgJCpr5pmYCjAIrnTKQ6JVCoaevioK6erEAToFWxAjkYFPnSo5imJuASPMIUKLUkddWORRYuXpcCmdLIDSejH9uxOKQ14qcDXtGdqhZSrTHDJae3oWUkx3AuuSd5bWapAm1FzJSqOYoqugaZ5GAuWaUw4wC/rqIa2cwjoUkxUBM6g2tHriGAe+tATPc43J1RU/UksJDPKrLEvCH+iInz13tzvFZJfPkOIJDQtwSmr1D1y0su4MD46pRtXWVgzaSJ1UPjBzyM4ba3CiGQl4/fhMl572wFQF01GZrjQTuiVE/ITXUjk4vNWJt5ZZ1apQmMBrCpBBlsisUGc+c33B5MkssUbXzHMHxZMozJo2UaHmD3dt8UWrmkWAN2NoBFZLBI9JC6pv55CDeCskDUJkdPALKhIHR3VCXOkw8EOYdE6yiBRCccQA8iBYXdYkxHpWpWFEH4P+yRVasE3D/b5UgTUW2fEsRm8H+Ka5t6gPg3q6xFRb8lhS3P3Np4r0D6MLodHMOetOdMmcrRToLAHef5fvYzYZfmozOL8js0xxWakfhvWano4eWovsIh/Xn8jHLRj6bdPo+8P8AiEZoFT6TFPvdTtUTpdgMPiu6Dtt0ieyzNyyJa8Bg4tiTou4N7u4U1jcGXTMIgO33Rtt5TQHyFLF2+tYNANvXDA7bXsDhzw0kiOWezMOJgzSsds0rPqVDSe7Vvpw8hqq3DYwuZrcjL+OJyd038sNURTto9qhRV4VpYaxGIWpyjRMlcbHtIsctLbf1vZQaazswBWCZttb5H7+SCnatrkFP43jtcK8Wo5TW8SDFHH/ttR2GVMpE9/Nf8x+LWahzdJ6LKQZJO9575295T26dDEORPrRHdkRj+QycakJDXcYOtl1kz+65vruaUqdfYwESywn4Hx4t1tKD7+dbhr+3N63rIpMebnUrMyV1B5GYgP18AYm+6ogaPCJF+SkSx403Z6UnPyfdMBp2qjvaQolDqJOfkXOclDy7YwHxNwPb/hWXKP9C2ffG46pB7mppXDi0W7AUFt76MhrKkQ/0n/kfBKs
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={"enterprise_license_summary_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/enterprise/license/summary/"}
>
</MethodEndpoint>
Get the total license status
<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"}
>
Query Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"cached","schema":{"type":"boolean","default":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={"internal_users"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"external_users"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={true}
schemaName={"LicenseSummaryStatusEnum (string)"}
qualifierMessage={"**Possible values:** [`unlicensed`, `valid`, `expired`, `expiry_soon`, `limit_exceeded_admin`, `limit_exceeded_user`, `read_only`]"}
schema={{"enum":["unlicensed","valid","expired","expiry_soon","limit_exceeded_admin","limit_exceeded_user","read_only"],"type":"string","title":"LicenseSummaryStatusEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"latest_valid"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"license_flags"}
required={true}
schemaName={"LicenseFlagsEnum (string)[]"}
qualifierMessage={"**Possible values:** [`trial`, `non_production`]"}
schema={{"type":"array","items":{"enum":["trial","non_production"],"type":"string","title":"LicenseFlagsEnum"}}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"internal_users\": 0,\n \"external_users\": 0,\n \"status\": \"unlicensed\",\n \"latest_valid\": \"2024-07-29T15:51:28.071Z\",\n \"license_flags\": [\n \"trial\"\n ]\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>