Files
authentik/website/docs/developer-docs/api/reference/rbac-permissions-assigned-by-roles-list.api.mdx
2024-09-13 12:17:54 -05:00

625 lines
30 KiB
Plaintext

---
id: rbac-permissions-assigned-by-roles-list
title: "rbac_permissions_assigned_by_roles_list"
description: "Get assigned object permissions for a single object"
sidebar_label: "rbac_permissions_assigned_by_roles_list"
hide_title: true
hide_table_of_contents: true
api: eJytWd1v2zYQ/1cEPW2AJ3dpH4Y8LRiCIkA/grbbHopAoKSLzZoiVZJy4gX+33dHShZlS7KS9sEyRf7uk0fyjnqKVQWaWa7kTRFfxjpjeYo9JTcG+0zK8H8loUizXaqVAJMKbmy8iAswueYVUSLdW7BRC41U9g1yGwVsonulIxYZLlcCmnHkUTHNSrCgTXz59SnmxOl7DXqHYxJH8LVUBQh8NfkaShZfPsV2V9GAsRq54QjIukTymNV2DdLyTZqJGioctSY5NLk0lskckCAAaiYLBNFfbyBXGhJWVYLnzjengyut6uq026oNDKBrA7rfq3eVVUkO2vJ7EgIb2FWM91H4BI3qG0hQE5Cmrz5sgWx0f0MDUjXMjy0YGNe1GGQeYiz6yVRKnxX2ANlaqU2JHvRz1KHvhXowCT1HunGaVpBxWRxTqtpWyqCkQuUbDBnQW/RJrqTEYDq28ADe1BloiTFmZhI0jd5gpdD9HEziGrsh7VpIWtRluUvc06OHYc5racksxrX2U9i8TFI9VlzvkgqX2oPShX89Q6DBrcGka04RrEDxKnHPKVirwUGVKbCGqrYuMJKuOUSg1ZYXOLXpSincKFJkvDEVy3G5uY7De4v8QfKhAO24iIJVCT3OSCt5rpVR95bWq2bJ4d29/hTiaUUVdV4k/u+MvAZrctz3p7li6xFDjZ5neGqWJyAxBPjRPtSH4A878FSwu2nJHXhaasFrk/i/l2DnKWNYKRJ6PB8+pZHJeZnQ4wy7FjbIjk7rhE7lXq9Rtc4hiF/fMQczZWNL4iLIn3+u6ftHttU+UYCfh5qvD52w89WpBDx6E6g1n6RDz8HM0d6RkPKzFXER5nSn1nySDj0HM0d3R0K6z1ekDecpRfqYSUUoV8ActenA5ENpPIBV0uvBDgecR4q/AihROA83pelLwo6ZkogUf7Ml0ZmZHwlzfXPleQb+b65Uq2zVl0k9MyU6YnrMlbZlgheYCPcltr0zpWLmSR2yz6TtfS6TtjFuQs4qTNpY0vyPCsB1YbAjaf7P4mhVNe0hWAESc0x8jDIK0tBRDCYAXCTuOYrBM0d2iX3Sfx2nklveZHxdczZwlO1J1jmO1KqsbOL/zgJG2fgtKGm2pjEUTRZOicAqw02cb07DhVpx6dCudRaMZUmLxuY0/EHzRhPXOgVjcsmkq6Rw7mV8t1/EGr7XXEMRX1pdw34xXI37yj2tNhMV+Z6IWzz6oinTOwH3TBhY9Pn3bxP+XfN8Hd1zEEVkVYSWRA+oetSyi9CQCIuZWqARM1WpvBOeo8ZVRESRrEusIaMHbtdcOtHYzSVuSkWjRGTADuqBCTGsMGk7ViQ1/L/navPBq6HuW8vJNRpsrSVdtThdZythgOl8/Wx/eLLIYkUy7fe7RYxRR9c67kopxncDeY3huHNXPYdYxLc7QqNNFe13hrhdvHpFf7gBUhlEzeAuZvnNkDZPp9K7eyWfM3DPrZkt7qmmsRIebYDyUx/vCYZngKrN4GCuajlMhiZrGBnDw5GJlKZtmCuuW21xh8Qyf3AcS67R0d6K/urNCoxoVe4U7KvTFx6KoonlVpCs286vTpwLykAXpjWjIMItqDRDru9H1ye6XZy4RMTg0xyzgf9cEdSfNqqBaFcauB7UwIqPUuzaja1ZATOAwf3lj1n1W4bOPlgkYAsisOvEGF4MLN4B/XJMVGcb4+9RB5CH2dzZNTrZ4aJc4DxEjvkAL1yMqWDZML8TdHdmnO4Ts2fjKJ47DQI3LMhzi8ONcdPXiQ9Cl2bloxu47eZhf7JqPIcwDhaHUDvidtXE7XmuwXbUrZrTZQXFFNt3dAnvWPfDjVz65gd3zz7Hf3wCTgvwWmt1uvakkqk7qlOg8TlrpTue3ewNj7Ci4CSWidtQ3r7zVKea12zUH69/oj/egsR9KI+ubm9GHFKAxYx6MNrHrQ0jpGEQxEQjdMJMWuKAK5g+4qzAf1yxa3xZ0vm7DGJ4efJJZ0n7Peht+x2m1oIIWcWX29fLeB8c3p/JS97M4Ag/GLS2tmrzAnrPMF9ojiMu75VDNiZ15IuYJHtDLl5dvEn+SH4/cft7tqHELyjU3JHAy0q4rIdml+Vudl1BQ8qAEOrPlTpISriiSWg/pVwesqH3N1+QhTebTDCXy+UK0706w4KtXAYsll0rEypbUv68fHfz1/WHz9fOTPp2UDIZMCf/976FHY64bBc5/0dDn9SCgH3h17VmTiye/ctKUKK/b4x8aoKjSc6Ot7iTAME+isY1fRdBoqenjBn4W4v9nrp9skiBU3DDMhEkk6MW/fKpifdfozFNN7ALvv9tmajBL+gBOR4bVifT+FG9nlt5TGge1D4vVObZ9ceENk3580JN5tYeZxRoy54X++Oo/pgQdyhwOll39IIpZEb7z1cqeteYZOD2RKHrqa7yHNx9QUt1clIQl8NG+/b6S1NXB3tgs+ct2gZxb89DuQt44zJyiC/0zRiXUqu6/4a8v8N9/n9LrrnQ
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 Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"rbac_permissions_assigned_by_roles_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/rbac/permissions/assigned_by_roles/"}
>
</MethodEndpoint>
Get assigned object permissions for a single object
<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":"model","schema":{"type":"string","enum":["authentik_blueprints.blueprintinstance","authentik_brands.brand","authentik_core.application","authentik_core.group","authentik_core.token","authentik_core.user","authentik_crypto.certificatekeypair","authentik_enterprise.license","authentik_events.event","authentik_events.notification","authentik_events.notificationrule","authentik_events.notificationtransport","authentik_events.notificationwebhookmapping","authentik_flows.flow","authentik_flows.flowstagebinding","authentik_outposts.dockerserviceconnection","authentik_outposts.kubernetesserviceconnection","authentik_outposts.outpost","authentik_policies.policybinding","authentik_policies_dummy.dummypolicy","authentik_policies_event_matcher.eventmatcherpolicy","authentik_policies_expiry.passwordexpirypolicy","authentik_policies_expression.expressionpolicy","authentik_policies_geoip.geoippolicy","authentik_policies_password.passwordpolicy","authentik_policies_reputation.reputationpolicy","authentik_providers_google_workspace.googleworkspaceprovider","authentik_providers_google_workspace.googleworkspaceprovidermapping","authentik_providers_ldap.ldapprovider","authentik_providers_microsoft_entra.microsoftentraprovider","authentik_providers_microsoft_entra.microsoftentraprovidermapping","authentik_providers_oauth2.oauth2provider","authentik_providers_oauth2.scopemapping","authentik_providers_proxy.proxyprovider","authentik_providers_rac.endpoint","authentik_providers_rac.racpropertymapping","authentik_providers_rac.racprovider","authentik_providers_radius.radiusprovider","authentik_providers_radius.radiusproviderpropertymapping","authentik_providers_saml.samlpropertymapping","authentik_providers_saml.samlprovider","authentik_providers_scim.scimmapping","authentik_providers_scim.scimprovider","authentik_rbac.role","authentik_sources_ldap.ldapsource","authentik_sources_ldap.ldapsourcepropertymapping","authentik_sources_oauth.groupoauthsourceconnection","authentik_sources_oauth.oauthsource","authentik_sources_oauth.oauthsourcepropertymapping","authentik_sources_oauth.useroauthsourceconnection","authentik_sources_plex.groupplexsourceconnection","authentik_sources_plex.plexsource","authentik_sources_plex.plexsourcepropertymapping","authentik_sources_plex.userplexsourceconnection","authentik_sources_saml.groupsamlsourceconnection","authentik_sources_saml.samlsource","authentik_sources_saml.samlsourcepropertymapping","authentik_sources_saml.usersamlsourceconnection","authentik_sources_scim.scimsource","authentik_sources_scim.scimsourcepropertymapping","authentik_stages_authenticator_duo.authenticatorduostage","authentik_stages_authenticator_duo.duodevice","authentik_stages_authenticator_sms.authenticatorsmsstage","authentik_stages_authenticator_sms.smsdevice","authentik_stages_authenticator_static.authenticatorstaticstage","authentik_stages_authenticator_static.staticdevice","authentik_stages_authenticator_totp.authenticatortotpstage","authentik_stages_authenticator_totp.totpdevice","authentik_stages_authenticator_validate.authenticatorvalidatestage","authentik_stages_authenticator_webauthn.authenticatorwebauthnstage","authentik_stages_authenticator_webauthn.webauthndevice","authentik_stages_captcha.captchastage","authentik_stages_consent.consentstage","authentik_stages_consent.userconsent","authentik_stages_deny.denystage","authentik_stages_dummy.dummystage","authentik_stages_email.emailstage","authentik_stages_identification.identificationstage","authentik_stages_invitation.invitation","authentik_stages_invitation.invitationstage","authentik_stages_password.passwordstage","authentik_stages_prompt.prompt","authentik_stages_prompt.promptstage","authentik_stages_source.sourcestage","authentik_stages_user_delete.userdeletestage","authentik_stages_user_login.userloginstage","authentik_stages_user_logout.userlogoutstage","authentik_stages_user_write.userwritestage","authentik_tenants.domain"]},"required":true}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"object_pk","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={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
>
</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={"role_pk"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
permissions
</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={"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><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</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 \"role_pk\": \"string\",\n \"name\": \"string\",\n \"permissions\": [\n {\n \"id\": 0,\n \"codename\": \"string\",\n \"model\": \"string\",\n \"app_label\": \"string\",\n \"object_pk\": \"string\",\n \"name\": \"string\"\n }\n ]\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>