eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-27 18:07:15 +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

389
website/docs/developer-docs/api/reference/policies-reputation-scores-retrieve.api.mdx Normal file
View File

@@ -0,0 +1,389 @@
---
id: policies-reputation-scores-retrieve
title: "policies_reputation_scores_retrieve"
description: "Reputation Viewset"
sidebar_label: "policies_reputation_scores_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVU1v2zAM/SuGThuQxkGStV1OK7agCLBuRb8uRREoNhOrsS1VkrNmgf/7SNlOtMbJgKEnyyRF8pHU44ZJBZpbIfNJzEZMyVREAsxUgyqsk09NJLWTWC1gBazDYjCRFoq0eOdmaxo8CPhlwKKJ4ppnYEEbNnrcMEGGitsEVTkq8M+LUBQiRoWJEsg4G22YXSsyMRgxX6BmLnXGLUqcZfk2g4vg/n7yLajMAxFDbsV8TWebCBN4Cd4Sli561PBSCA2I2eoCyqcOs3xBuW5LwFBmICq0sGuHgRc2Ic9L/HuiG1gVJXODpphyv9ejTyRzi0Z05EqhJxc3fDaU6GYfopw9Q2SP1fQWtOCp+A2ayqqpX1ZUMdXy38VCYMKm8LfPpox1qQT63nNEanVAPF2AnMbcEpJKwE3uCdzIeHcFFmXhAGT8VWRFxkaf+/3B4KzfG5yefxqenZ32ej3UirzSnrSqt8jQ3+mQUikUBqUuHikDWZxYkYFrO49/5um6bnvpD8KjXw4Hfuf/qa2MrCz3RpGSGr7rKDxg8+OqbWOt5f4U5PiCMOc0ngLpjeeSa83XhMVCZlp6iclGMoZ2DY9jQWF5eu3HK3el2KVWZXawHoN3rMcl5PgiouDienKgIDFYLtLW0T2M1p+D2oHX9DroEZgoQr5LJLHooqZApLsRCxtCCXeMF1acGm7ekGAZEg2CXjW8WeiUXHAlwtUgZKXHSbdUrwqwx0xbaIm1quFU+p8B16BdniKfS2dZg9td7zCKXEHq9/rD7nm3v9eAK74kam1uVW0MjMhU6qiV+swj12dsKDWCJZCm8stCbiN1haR2YGEACdRNcbUVriZ39OwcbIJgRmG4EDYpZt1IZqHnItydZqmchRgqD79Pvo5/3I4dTCWNzXjuOW86EezKHlSdCA5tN29s2xddXW4LrzZUKebgaEm78asmwFspHW/rsZomSTraX4Y0fQkioPubzYwbuNdpWZL4pQBNKwmPK47LYUZdxGGJhaEzTuCcpwaOIPlwU0/7x+A/dmcr5IZxcuKbFU8L+sPjEtYty758wisJkjFtHky9srqIIlDWu7/HE/QAts/sckyzQmPgzX09553mQN5bc8OiOos7uYQcC9ukaumfEizLP7mpJVA=
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={"policies_reputation_scores_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/policies/reputation/scores/{reputation_uuid}/"}
>
</MethodEndpoint>
Reputation 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":"reputation_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Reputation Score.","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={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","title":"Reputation uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"identifier"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"ip"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"ip_geo_data"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"ip_asn_data"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"score"}
required={false}
schemaName={"int64"}
qualifierMessage={"**Possible values:** `>= -9223372036854776000` and `<= 9223372036854776000`"}
schema={{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"updated"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"identifier\": \"string\",\n \"ip\": \"string\",\n \"ip_geo_data\": {},\n \"ip_asn_data\": {},\n \"score\": 0,\n \"updated\": \"2024-07-29T15:51:28.071Z\"\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>