mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 09:35:07 +02:00
389 lines
14 KiB
Plaintext
389 lines
14 KiB
Plaintext
---
|
|
id: rbac-permissions-retrieve
|
|
title: "rbac_permissions_retrieve"
|
|
description: "Read-only list of all permissions, filterable by model and app"
|
|
sidebar_label: "rbac_permissions_retrieve"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJytVl1P2zAU/SuWnzapNF0BaerT0IRYJdgQbHtBVeUkt42pYwfbqaiq/Pfd66TUowFNjKf64+b6nHOPr7vlpgIrvDR6mvMJt6nI5rhSSudwzc0teCthDXzAc3CZlRXFYuQNiPzIaLVhSjrPzIIJpVj06YAtpPKYPFXA0g0rTQ6KCZ0zUVWYrhJWlIABjk/utlxS0kr4Arc0buBM5jh2WQGl4JMt95sqrGoPS7C8eY7ojNVaPtTAugi2FopmOWgvFxupl8wX0kUYh5jfwkMtLSB5b2toZgPuxZIgBS04zh1ktZV+E2CK2heUb4WzGUVbcBWyBUcQx6MR/WQGEWhPQ+SqZBYETu4d4dweUjLpPWT+QOILZVIRa0qqWSqYl+15qNChMIRJ5D+wNB2nnaBPkQ5rqpcYWIrHS9BLFH0yPj3FwAyL9A/Bn0YjDA4V7Yv00itauN74wuiu8pkSzrGQvAch6jRXIu3P93L0fA02Na4X799ifqtLoY8oUzAkZmDteT3pA+A3p27p9hNtYsPdRaz7OEXlGLSXoVX8OcCuvrNI+L1lmubgotDVOXlXp/4WSubhU3ZurbEHRtVGzxcSVD4H2ndRSmGt2BBBD6U7FLvpXNm/I/Jc0rFCXcfnNXsp9tBaZC/qcfyeNxc0WJmxs+vpC4Lk4IXsMfurbGPrdAmioneHvkKTrA14JanTL8GHJkzXmSfU65KoeSdbmTcJtV+w612Lrq2iWFHJZH2c8CbqjbckTMss6pBPHArvq10vp3kKwlILR0BSL0yI7FjsPx9wOrnFPh6NT4afh+MDpa/Eihr77qu2XszJslIwDDdIe5GFgmLlSHFegFLmy9I8nTSUhnTHaoNu73v3AF1Nf2KKljZRcJMkWUpf1OkwM2USpUj2oxS7doJH6eRy+vX8++15oFkZ57FLRMlJ8vi9ZC89tZEr///V7Qri4dEnlUKUxDww3HZm6B4+hLzPirNJaEDktwKpUNh2mwoHv6xqGlrGl9fSG4nDtbCSAATX5NLRGD23EMrBK+Q+3HT+/sje9pb3ktu1GU1NJqShuzDgK9i0/zGaGUYVKCw6kgC3G2dZBpWPPjnoB+T/p+t0cU5WIRdEtu9sPtgNKHsvHJQyRPw0K9Ao5w6dpzkBbJo/V8RYxA==
|
|
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={"rbac_permissions_retrieve"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/rbac/permissions/{id}/"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Read-only list of all permissions, filterable by model and app
|
|
|
|
<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 permission.","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={"id"}
|
|
required={true}
|
|
schemaName={"integer"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"integer","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"codename"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 100 characters`"}
|
|
schema={{"type":"string","maxLength":100}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"model"}
|
|
required={true}
|
|
schemaName={"Python model class name (string)"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","title":"Python model class name","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"app_label"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"app_label_verbose"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Human-readable app label","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"model_verbose"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Human-readable model name","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</ul>
|
|
</details>
|
|
</TabItem><TabItem
|
|
label={"Example (from schema)"}
|
|
value={"Example (from schema)"}
|
|
>
|
|
<ResponseSamples
|
|
responseExample={"{\n \"id\": 0,\n \"name\": \"string\",\n \"codename\": \"string\",\n \"model\": \"string\",\n \"app_label\": \"string\",\n \"app_label_verbose\": \"string\",\n \"model_verbose\": \"string\"\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>
|
|
|