Files
authentik/website/docs/developer-docs/api/reference/rbac-roles-retrieve.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

344 lines
11 KiB
Plaintext

---
id: rbac-roles-retrieve
title: "rbac_roles_retrieve"
description: "Role viewset"
sidebar_label: "rbac_roles_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVcFu2zAM/RVDpw0IoiztgCGnFVtQBGi3om12KYJAtplYjSypkpw1M/zvI20nMeq026GnSCZFPj6SLyUzFpwI0uhZyibMxSJZOqPALx0EJ2ELbMBS8ImTlrzQ5xbN0VbCbw8BjVY4kUMA59nkoWSSXKwIGZo0GvBWFDLFm08yyAWblCzsLH33mECv0bIyLhdh71m9THgRzeez71HjHskUdJCrHZ1DJn1EeIYYxcFTIR1gGcEVUC0GLIg1gaqrYnj3kBROhl0NVBQho0gbvC3I24G3RnvwBHE8GtFPYnRAJzoKa5VMaqr4oydgZb8kEz9CEk5T5sFJoeQfcMSaI+KDbLLZzb9pIYAi/anVrikQy5NB0YN5y1pDdz9OLp6vQK+xJZNPn0dV1aXqoXk1IAiLY0gCzKqq1wpKc/6u1PxCStL6aTR1zvS50UYvVxJUugSy+05I4ZzY4QMZIPf9ygl+YtITnJBFpKmktELddPNVRxKO0Bpkr/Jx9o58XILGOUmii5vZK4SkEIRUJ4p6q9pux9sAnXa3Sd8oEz/hkmeGRGLd7j0NFOO0XLyWDF7SoFacdh3cdq8IhVPkJ6zk2zPOqs4i3hEpTVWddTzgz0Kwe+GgewzCgavBSL0ytWdbwfH5gFHmBvd4ND4ffhmOeyxfiw3px/5V06vIy9w2WkLNFEndTOwasc0yUMp8XZtDpqE0xDl2GlA16lFt9O56do8hmrKpBD/hfC1DVsTDxOS8E4IfT7EyMcdUml/Nvk1/3E3rMq3xIRe6E5zojmq6o9cUujOLL8W6JTbAc+BWYTaqoEZatg1t1RInhnLg76RVH5qXDOGQS1nGwsPcqaqiz08FOBJVPG4FilxMLcHOp9LTGWdmJZSHN2B+uG3n82P0n2p/spK9LmhSha1QBd3wuIHd4d9lgX4ZKikOEmFsTBdJAjZ0HvVWmMb2sAGXU+owNa8zre10DvYHin4SELJXe9ybDWhkcI8v0J0AVtVfwgqYxA==
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_roles_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/rbac/roles/{uuid}/"}
>
</MethodEndpoint>
Role 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 Role.","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={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `<= 150 characters`"}
schema={{"type":"string","maxLength":150}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"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>