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: policies-reputation-list
title: "policies_reputation_list"
description: "Reputation Policy Viewset"
sidebar_label: "policies_reputation_list"
hide_title: true
hide_table_of_contents: true
api: eJytV0tv3DYQ/iuELr1sLNc2msCnpoVhGEhSo3n0EAQCVxqvmKVIhaRsbxf73ztD6sHd1b7cHAyvSM7wm9fHmWWiazDcCa3uiuQ6qbUUuQCbGagb59czKaxLJkkBNjeipiU8+He/z+5JZsG+CHiyQCdrbngFDoxNrr8uE0HnfzRgFrincAc/8xLyeSZqXLH4u+LJ9TJxi5r2plpL4CpZrSb7hBsLxi+8SIUB7qAYk7XOCDXDnQdtKu5wpcCjr5xAwZ364BnyJnhLz2ZB/nRUkluXNXXxU6Ht8lGrzMu1R7UpoL3BwI9GGIRx/cClhcm66vVc+KcUeckeBMiCOc0wMOypBMU6dcyVwAzYRjp7diSUms/gRBhvGQkx1VRTMOxJuFIofzUuC0U+bUEwTNNRHEI5mIHZApJZ8e+paD4EGPqhs5xcY8A1RjEsOY/1MIixgPoaXWRNI45MEn8ytskCN3l5snuDGMPCrg6GcQy4K9EVpZajsAezv00Sx2fEHT0dJbhmscKMcAvPKbzBwCon5vj1jSRQc62VxaOo8uL8nP7lGnUqRz95XaMmz1fpd0v2LLch6Ol3yD2BGWJFJ4K2Nn1EkNp/VsGzi06FXExWdAwehW7s6GauGzUuhiYb2LHntOMyozwa12odNy4TqoDn0X1Qxc7dVZwbX4NZkREd5AHgOpz1y+OrKLjCSbrrfvCrv85XSYSFG8Mpe4SDyo65/tCL9BHZh0ssXbMd0/nhiiFMvPhLSUw5ZxqIkAf9oa669N4qg8nIq7D9GGyTKRBrCcu0X2L4CxSfSigmjEvJeqWWyMWfDIyAlIfbU2B0GRRn7I8FK+CBo1snTKMZgygDY7SxjJv+dMjDCotoPd9656zDvAXHQiBYL8WsRjzcsSdgc6WfWIl/yHpQCOeJuI/cumPx5kcwU20hG3fldqg9jQZ1v1i2Jn1Ae1bLxnB5+iVB7uBd2PjwrNIFyNOMIf7DfkYyL8t2qZ9i3RWZ0yPMudeAPkkwXbwODMyY/r4xG2lbJpud1+iZgeXHIFb8WVRNlVxf/Hr1+urN5W9Xr3FRqLD4ql99s0lBveFxmm67e9L1O1jhG2k1ngcRIQ0MEgocaXADRPQUDIy1TWlQbKp6Rz20V7ceI3LY1f98rdY1fkHGKwIN3lCRbz9RSEe+V8sCCRzBuMPDjiiLMa7DHV5gmeO1XN7H960G7wzQArKd/rj8if64BYXPQM7e3t/tcEiBKSRGCGGvtXFWtAqiPGgv3WNmYIpS09A1a6cmV+JH2vU86TCCpfSggnnsJqrGSDrJa5E+XqbJKuqOPpJbgl1Rj9RbUDrXz1y+brGla997oR4Cq7Q2DOK+cGxAfnF+cXX25uxiy8/v+Zxa/U4qRItZUdXS97kUTp77cGLcyN9JCVLq32e6v+lMaPI62g/YyvlkDZ3j+7tPqCKYTSbY6zSdYYPfTM+QDNJIRTr8mko9TfEqlb67+/Pmw8cbb2atrau4ipR3DmeDw9nYzBul5N7xt3W1w54prSXeTzZ57Ms2yFFjS5nUqcIPSqISEdKZ5XLKLXw2crWi5dBMU/gLYX0/0Hftc1isz9SPXDYQyunA8WiKPkqon5uPOT02FR8jtzEHHyNylA07w3nqBDsa4gAkmqFfCObkOXYPmnaMfiGSY2fYAwC68fmYOK4Pty/24MaougdgPwsfgy6eYIfz3+gDR40p8SaOo1jC2FYhrVKxBsG3eQ61i6S2njTS0r8ItzfEd0RlcY8VuHrS/SDt3cOtFpFuJA5/4pOeg0Ly6NHTN16ED9J/gZLlzw==
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_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/policies/reputation/"}
>
</MethodEndpoint>
Reputation Policy 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"}
>
Query Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"check_ip","schema":{"type":"boolean"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"check_username","schema":{"type":"boolean"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"created","schema":{"type":"string","format":"date-time"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"execution_logging","schema":{"type":"boolean"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"last_updated","schema":{"type":"string","format":"date-time"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"name","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"policy_uuid","schema":{"type":"string","format":"uuid"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"threshold","schema":{"type":"integer"}}}
>
</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={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
pagination
</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"}}
>
<SchemaItem
collapsible={false}
name={"next"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"previous"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"count"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"current"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"total_pages"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"start_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"end_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</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"}
>
results
</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"}}
>
<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":"Policy uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"execution_logging"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"component"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name_plural"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"meta_model_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return internal model name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"bound_to"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"Return objects policy is bound to","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"check_ip"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"check_username"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"threshold"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pagination\": {\n \"next\": 0,\n \"previous\": 0,\n \"count\": 0,\n \"current\": 0,\n \"total_pages\": 0,\n \"start_index\": 0,\n \"end_index\": 0\n },\n \"results\": [\n {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"execution_logging\": true,\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"bound_to\": 0,\n \"check_ip\": true,\n \"check_username\": true,\n \"threshold\": 0\n }\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>