Files
authentik/website/docs/developer-docs/api/reference/rbac-permissions-assigned-by-users-unassign-partial-update.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

336 lines
20 KiB
Plaintext

---
id: rbac-permissions-assigned-by-users-unassign-partial-update
title: "rbac_permissions_assigned_by_users_unassign_partial_update"
description: "Unassign permission(s) to user. When `object_pk` is set, the permissions"
sidebar_label: "rbac_permissions_assigned_by_users_unassign_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJzNWF9v2zYQ/yqCnlrAo7K0D0OelhXBFqAdgjbdHrrApaSzzZoiVZJKIhj+7rsjJUvyH1kZ+rAH09Txd8fj3ZE83ibWJRjuhFa3eXwVm5Rnc6QUwlqk2TnH/6WCfJ7W88qCsfNKBdq85MYJLudVmXMH8SzOwWZGlCQMRX1ucFEn7pV9HTkdkRwW/b0CFX3V6TfI3Lxcf42EjSy4WeRW0OOx/yhuINJK1lGrDAkhlC0hEwuRRUHKLNJINU/CAg0jHhl3PEupUy5lzVBTVJ0X4HA58dWXTSxI35K7FQ4pHMAvkWPfZisoeHy1iV1deqpysAQTb/cXex1VSnyvIGoQ0SOX9JWDcmJRC7VEjXCBn2npKNnA90oYQJM7U8H2YRY7viRlvAfih4AA637TeU0KZBoFK0ddXpZSZN5nyTdL028ONQ0WOXDKxyCVDNh4h0cKnnr2JusYCgonwJLAnit68rkxvEascFD06dYZXCwOFEK9B7VEm179vEV7FToHSUBQVUEL5RX6CK2znuPCuHKW5brgghTohjJTl06zjNRZ0KJhDXXJhRmgFlI/WUbtCbJF60IqVB506yC6cqW2fu5sjeEA5lFkgMZWaL1gjSPgdZWCURg/diJD0xkMlhq9iDae51VR1My3nlYfh8EjEuYFd+hqw/xX8zHK9VwKU7MSvf2kTR4+zzAY8O5mXXeMYQlalMy3Y7BWg50qY2ADZeV8hLOuO8LAwtgxD2MwP+I2xINL5rxk1LSkEzhNxEtmM9wFBaJPS2yQ4e+MVOw9ox+oPYM0PBeVZeHvv2Cb/VuPK295IRk1Z6bo46aIzUTBqDkntsUdE0eHIDNawoBqdWUy6DkyEKZgxnRvWbwbgzNHBB+gpoume6/HeOLQGPIsja7K6UylhGdGzcgK9jBT9PcspH7HNkURr/xkll2gjei+h5miu2fxqcuObYoiXvfpLG00j+k+xIzqTvcVJl8NAe89bfCe0GxAQYIHTmPFXw50WZ2H28IOZ0LCxJmIFX+TZ6KjPdubzNOmzhcEhL+pszrtyuGcRJk4o2emZupsmAoKypCHM7bUibM+QUoENRTSUl8qpO2cXkLGS8wtOGv+T06A+8IigTX/Z3G0EZv+MRjmy5gKYXNSUC9bOonBa1tI5tuTmCY1bxJpNvw8zaUeRZOYdN2XoY8BD5KjkyLx1ChKx8LfWcBJMeQGNLbEHNa7JHTH4VIvhfJo3zsLxqS3RWN3HP5kRKOJ7x2CU8NVbpn/Gw7gO6vENwdm2buuV07tBXamDYRT/ZBMEx9Sew+tw0Gn1zAkY0u5F74+GbIBxviJ1Gep9VLCHP28tiXPUCtP2H2fyZymso/naYXIjLZ64Uhvw9nu23+eUWEa87gChlI8np1NcDMGCh8LYu/AOCbo3H0aLl7WXMgHMebfVDY8rY4NKN2dELhMZUu8OM4Bz42bSh7Voo/B43ql9bpdGVUL9l7bTjhJhA/0yr6hFzY+uXe1lSnv81bCnX9T5ne7V/+1rxM0hYN4uyWwhazCfVr76slOdfx62PrSBVoGw9/XBS4v3tLfsAzxqcrQAXZRSVlHbUEJclL67cXFD6x3/BVuWfyIbozR5qC6obSaLwTIfA40/oISB9khQ3MfH+F5LmhaLu/68/UM3akWNPOGHWof7PHmB9rjd1BgRBZd392eMEgODq/NI4saW21XzvrSCnjoVtpMOrJMqg+BW+k81OGyla/RUWzGCb0Fk14RKjkoSSYbkW+TNowSKtyBeWyLe5WRJIaXInl8k8QUoG34fiKrhWX3gni3wJVzZVsFpO8UuKHiH2pLdv/YVehunnlRSjgol31pjfSwK4CN1b16G7ZndqEW2mvVmLNTdRbTKoMRLy8u37Jf2OWByz/wNZUfe5kg7QYrSGEqRVJk8cxHls+YaOEgpf51qXczMaFJk/Zao30TyqQfbu9RRDAxmcteJclSuFWVYkZYJD0RSddLpU4TWnLy/vbdzZ+fbrxJqUBWcNUTTp7vV4K7Wm5a+yKy3Z0dUVOMjo4Xo3v7539dl24Cz8GzS0pJQbFtrLtp9kNTIJ4N4gyPm/09gbQrX8NuLYRdisIVlSFRymaTcgufjdxuiYyRbOg0x+4jN4KnFGm4eXJhqY/7csGlhRGzvvrYnAGvo5cWw4+uuj2EFR3BXgCdFLN4DXUoz28fELUCTrkDqRoG3gWFfron9o7x4MzczlqOa7yKfCp9GvvQO57uru/f/YHotCnMF/5QjA2n2jO1XkvtLeRPFk/bxJKrZUUZx1UchPpboiKf7g6c5oCZtR1a1lE7oPc84p6SUPRga5aQlKJlttt/AbczxJE=
sidebar_class_name: "patch 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_assigned_by_users_unassign_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
path={"/rbac/permissions/assigned_by_users/{id}/unassign/"}
>
</MethodEndpoint>
Unassign permission(s) to user. When `object_pk` is set, the permissions
are only assigned to the specific object, otherwise they are assigned globally.
<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 User.","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>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"permissions"}
required={false}
schemaName={"string[]"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"array","items":{"type":"string","minLength":1}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"model"}
required={false}
schemaName={"ModelEnum (string)"}
qualifierMessage={"**Possible values:** [`authentik_tenants.domain`, `authentik_crypto.certificatekeypair`, `authentik_flows.flow`, `authentik_flows.flowstagebinding`, `authentik_outposts.dockerserviceconnection`, `authentik_outposts.kubernetesserviceconnection`, `authentik_outposts.outpost`, `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_policies.policybinding`, `authentik_providers_ldap.ldapprovider`, `authentik_providers_oauth2.scopemapping`, `authentik_providers_oauth2.oauth2provider`, `authentik_providers_proxy.proxyprovider`, `authentik_providers_radius.radiusprovider`, `authentik_providers_radius.radiusproviderpropertymapping`, `authentik_providers_saml.samlprovider`, `authentik_providers_saml.samlpropertymapping`, `authentik_providers_scim.scimprovider`, `authentik_providers_scim.scimmapping`, `authentik_rbac.role`, `authentik_sources_ldap.ldapsource`, `authentik_sources_ldap.ldapsourcepropertymapping`, `authentik_sources_oauth.oauthsource`, `authentik_sources_oauth.oauthsourcepropertymapping`, `authentik_sources_oauth.useroauthsourceconnection`, `authentik_sources_oauth.groupoauthsourceconnection`, `authentik_sources_plex.plexsource`, `authentik_sources_plex.plexsourcepropertymapping`, `authentik_sources_plex.userplexsourceconnection`, `authentik_sources_plex.groupplexsourceconnection`, `authentik_sources_saml.samlsource`, `authentik_sources_saml.samlsourcepropertymapping`, `authentik_sources_saml.usersamlsourceconnection`, `authentik_sources_saml.groupsamlsourceconnection`, `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.invitationstage`, `authentik_stages_invitation.invitation`, `authentik_stages_password.passwordstage`, `authentik_stages_prompt.prompt`, `authentik_stages_prompt.promptstage`, `authentik_stages_user_delete.userdeletestage`, `authentik_stages_user_login.userloginstage`, `authentik_stages_user_logout.userlogoutstage`, `authentik_stages_user_write.userwritestage`, `authentik_brands.brand`, `authentik_blueprints.blueprintinstance`, `authentik_core.group`, `authentik_core.user`, `authentik_core.application`, `authentik_core.token`, `authentik_enterprise.license`, `authentik_providers_google_workspace.googleworkspaceprovider`, `authentik_providers_google_workspace.googleworkspaceprovidermapping`, `authentik_providers_microsoft_entra.microsoftentraprovider`, `authentik_providers_microsoft_entra.microsoftentraprovidermapping`, `authentik_providers_rac.racprovider`, `authentik_providers_rac.endpoint`, `authentik_providers_rac.racpropertymapping`, `authentik_stages_source.sourcestage`, `authentik_events.event`, `authentik_events.notificationtransport`, `authentik_events.notification`, `authentik_events.notificationrule`, `authentik_events.notificationwebhookmapping`]"}
schema={{"enum":["authentik_tenants.domain","authentik_crypto.certificatekeypair","authentik_flows.flow","authentik_flows.flowstagebinding","authentik_outposts.dockerserviceconnection","authentik_outposts.kubernetesserviceconnection","authentik_outposts.outpost","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_policies.policybinding","authentik_providers_ldap.ldapprovider","authentik_providers_oauth2.scopemapping","authentik_providers_oauth2.oauth2provider","authentik_providers_proxy.proxyprovider","authentik_providers_radius.radiusprovider","authentik_providers_radius.radiusproviderpropertymapping","authentik_providers_saml.samlprovider","authentik_providers_saml.samlpropertymapping","authentik_providers_scim.scimprovider","authentik_providers_scim.scimmapping","authentik_rbac.role","authentik_sources_ldap.ldapsource","authentik_sources_ldap.ldapsourcepropertymapping","authentik_sources_oauth.oauthsource","authentik_sources_oauth.oauthsourcepropertymapping","authentik_sources_oauth.useroauthsourceconnection","authentik_sources_oauth.groupoauthsourceconnection","authentik_sources_plex.plexsource","authentik_sources_plex.plexsourcepropertymapping","authentik_sources_plex.userplexsourceconnection","authentik_sources_plex.groupplexsourceconnection","authentik_sources_saml.samlsource","authentik_sources_saml.samlsourcepropertymapping","authentik_sources_saml.usersamlsourceconnection","authentik_sources_saml.groupsamlsourceconnection","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.invitationstage","authentik_stages_invitation.invitation","authentik_stages_password.passwordstage","authentik_stages_prompt.prompt","authentik_stages_prompt.promptstage","authentik_stages_user_delete.userdeletestage","authentik_stages_user_login.userloginstage","authentik_stages_user_logout.userlogoutstage","authentik_stages_user_write.userwritestage","authentik_brands.brand","authentik_blueprints.blueprintinstance","authentik_core.group","authentik_core.user","authentik_core.application","authentik_core.token","authentik_enterprise.license","authentik_providers_google_workspace.googleworkspaceprovider","authentik_providers_google_workspace.googleworkspaceprovidermapping","authentik_providers_microsoft_entra.microsoftentraprovider","authentik_providers_microsoft_entra.microsoftentraprovidermapping","authentik_providers_rac.racprovider","authentik_providers_rac.endpoint","authentik_providers_rac.racpropertymapping","authentik_stages_source.sourcestage","authentik_events.event","authentik_events.notificationtransport","authentik_events.notification","authentik_events.notificationrule","authentik_events.notificationwebhookmapping"],"type":"string","title":"ModelEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"object_pk"}
required={false}
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={"204"}
value={"204"}
>
<div>
Successfully unassigned
</div><div>
</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>