eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-26 09:35:07 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
7a6d44d0dfd3a144df03f734283531f69abdebc6
authentik/website/docs/developer-docs/api/reference/rbac-permissions-roles-update.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

453 lines
16 KiB
Plaintext
Raw Blame History

---
id: rbac-permissions-roles-update
title: "rbac_permissions_roles_update"
description: "Get a role's assigned object permissions"
sidebar_label: "rbac_permissions_roles_update"
hide_title: true
hide_table_of_contents: true
api: eJzNVt9v2zYQ/lcIvWwDXCtL+zD4aVlhFAHa1UiTvaSGQUlnizVFqiSVxDD0v++OlGzaUoIFyMNebEm8n9/dfbx9omsw3AmtrotklpiM5yv8Uglr8ZtdGS3Brpq64A6SSVKAzY2oSR6lP4FjnJHIL5Zx1NgoKJjOfkDuWGQFFWtueAUOjE1m9/tEkHrNXYlHCg/wTRT4bPMSKp7M9onb1f6rcrABk7Tnvq9Yo8TPBlgnwR64pLcClBPrnVAb5kph2cboph7GNEVnBn42wgDm7UwD7XKSOL6h+DwMyTJIgHV/6WJHMeUafSlHj7yupcg9cOkPSxHth8EHrwPY7iyGewyFPQpXMl4Ugs657IJ9Z0Ai6AVD6DkhaKhUToAlD0FmVW8jd9YZTBtFK6E+g9ogurPf2zZO9D5SpHyFk6Q5f3KG32Adv/rTxSG2mwBA0p6a8XhhtSBvjHA7X1LeuJKwx4jul60Hz9ZY/BDv5cXF/wxB7Ldhm1HUvPiq5O6QZK6xpXyLDoEeCFcoLMcke6QXO1diwF6O5RKHhnnjI7YQoJXk2bi9gfQLDdH2M/YfzBycrh7AZNqOao2wQF0zr8bWRldRaZAYAibPgfU6PwG3V3vqwDmxN3SnGomWqUyk9rz76HsIgjvHsXOLcD5lt0Q8B2Jljm8B+dExCdy670oriJsVJ8zsJoyrAhkLTqyTGcyD2VI/4tvaCzTY/CmRLiu5pS/f1YOAx1U8EOQVRQ/jc4bIGSccO22sAaIRmASW7nE+LWDXZaNoT17JO4FwTgtAffzhTWnkHy5FEWo0N0abAUdgqVZrAbJYAZ3byCQ3hu8IEAeVHZm5jjnGT47VX8T+2iMyx9BCZM/i8f4N8fgECozI2dXi+hlACnBcjBDSi9nGrdYZiHqgc/pCmkQVgLRJC0rdOL9N0N2WpHRPp9Gi4cfCpntRtCltE2Ae+o2jMZI0eC3Sh/dpQhdUf319I3hCftEldsikdK7uVxN6z4Ab2kgwLAL45rgjzJ94VUs4u58jjIRaa2+5y/3obpJQpCHjy4vLD9M/ppeD+nzhW9preq1QZWYFOZ36OVVIRL4NsN5Up6QEKfWfG33wNBWaIsEeARVYt9u/vlzfookAE6VsZ2m6wXu1yaa5rtLIRHp8yqTOUnSl0s/XH+d/f5t7WGptXcVVZJwKFW+Efmm0bHyvjPr5NStmVy4HTy6tJcZEefp89l3DdIsdBnii6GPB/5knN+rNEhMg8f0+4xbujGxb+uyZmtYbrBY3ItwV2FuFsPSM/bnm0p7fHHE6v950s/Abe4MFdjTjnp8UsZO3SUM0SbawC1t2u0SpEi8EbGKKPhx8DDG+uyX1o+KATtpJr3GV51C7F2WX0eQu7qi/sm6VrjxbJIY/UgHw18eoPWR+Ev23fSK52jR8Q7LBpKfPhqp5GNBuICf9AyU1igKW00vc6i0oLGkPiqN3wqVt/wVwo5Vt
sidebar_class_name: "put 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_roles_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/rbac/permissions/roles/{id}/"}
>
</MethodEndpoint>
Get a role's assigned object permissions
<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 group object permission.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3><strong
className={"openapi-schema__required"}
>
required
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"object_pk"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><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={"codename"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</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={"object_pk"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
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":"Get app label from permission's model","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"model_verbose"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get model label from permission's model","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"object_description"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","nullable":true,"description":"Get model description from attached model. This operation takes at least\none additional query, and the description is only shown if the user/role has the\nview_ permission on the object","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"id\": 0,\n \"codename\": \"string\",\n \"model\": \"string\",\n \"app_label\": \"string\",\n \"object_pk\": \"string\",\n \"name\": \"string\",\n \"app_label_verbose\": \"string\",\n \"model_verbose\": \"string\",\n \"object_description\": \"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>
Reference in New Issue View Git Blame Copy Permalink