Files
authentik/website/docs/developer-docs/api/reference/policies-event-matcher-partial-update.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

521 lines
45 KiB
Plaintext

---
id: policies-event-matcher-partial-update
title: "policies_event_matcher_partial_update"
description: "Event Matcher Policy Viewset"
sidebar_label: "policies_event_matcher_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJztHNuO67bxVwi/JAG29ulJHop96uZ0kS6Q0yzOJX0IFgIt0TZjSVRJyrvOwv/emaGom6nLCQIUbfXgXYlz4XA4nIvG8utKFUJzK1X+kKxuV4VKZSyFicRJ5DbKuI0PQkcF11byNCqLhFuxulklwsRaFkgHVPeIzN47ZPaIPM7sZymejbCADNQ8E1Zos7r95XUlkaTg9gCgHAB+2nNUljKBQQNsMr66fV3Zc4FgY7XM9wDZKQ0iwQhhXvpy3LHPnx/+xhw6kwlIJXdnvLYHaVhIzDVw1eJfpdQC1m91KS5PNyvL9yhrrY7Vk8MSxn6vkjOKFqvcAju85EUBaKTEza8GJXm9XoPa/ipiO091H4UGbcvfhEbtadwii1IAN6ewa81kMv9R5HtQ6u2fQS/iRcQlThGlar9HlIZmq1QqeH4lyj8PIneKUjTE4ErkfJuK5IbxNGU1U8DYOUy3cexZAngrGE4mkjX7/swSseNlam+YytNzQ8qE1kobxnWNjfvIYycEKDNNf9qRnYi8zHATAE2itPQ/2nEJArlbVaJCSwMW+qwlGaYpTQFbpkoTVRtGBmjMs9JJ5OzRiFgLG53AQJs7rawzbZmfpKXNjIAzzsRLe1AatiNq7TRSqlLHIkplfiQ8mcFGwf47YmPh0ATGRZ7Q6C5Vz1GtF5TSHYLgUCwKP+TM4QxnsyhgYztAczZWZJHl5tjh0x2/wm8PgV3v5L7UlbC4W2heKhFpBIribknu3rmD5h4+wt2D7csU1J3TBhFaxE8whuaEs5TGqizCc9W3ZCttKvzJuCO7MCs8lHmZOnI6pn3rpSPEKgkZuS8DdmkPzlCdgTGcbM3I0lOxs0xkhT07625hmNqgnQN0NhqnEn2iLELnry9c+zwGRRWVP/rKsHfEmD08sq+RX2zdtMD4hoHHY7mwYL3HepSBXTKes/uXQgtjUGrnOL6ho1QU4XOEZowe8bgGx8VBPZVpuzGeZHTKWiOF7NzH+lxY1RlCG+6ygSNZKNPj7d3oOimz7BwGdQLOAMpLIfUQea2LMHwvFGxcEOS9QxiqRVFaf+Kv4d1BrU4QdbRZpwkvBkAKB98OAOHq5TwA0zyR5dCEhmfpECiWWQektzzuDohYnURPtc67BZbiAbSQIKRIxUsQcCVlDejLCN5zD+N+AHyu0pMIUVKqaSSTmRlIuOfxNJ5VtpjGOkE0rzKnCcxnscWBPIQZ8wJOBw+CwEk6Z3sFgizoHBy/OosVgHx3CFAlVE0AvMaoY2cIGjxoHqYVuOIQhMK7iyyDYJ8iDEJdphAG+9ShgW41z5OukWzTUhTg63ueLVa6Swp/hQZEMzQM+51IOwRsTu1eqX0qInT8puDxILuGIpOxVkbtLKQYVvNpAt1zAy2kSj/ueHaRKLKOBe67orjHkDM3Zlex2ofu7ZkZ2O0Yr1v51lDUbjBcUtmO2JSVTATDqAqG60SB3XeMKHIRbx1j+k1mL47iXHDZ8UQRBUEKhQPDpMytzBOnpwbFB0uYOz7Cjgh9kjH44jwXcf8QNcjHcis05AQQ7uYRVBcdYF3okRtwzsBlm2G0Tnh2RlDdjFJRxK4PvrudIKjCeCuijxFQXHfRfQzNS1CLMobchPxW9B8hcMnAObTD9WGLMIxSLPVDA3guPYCACGl+leKPY7p/E1wpr3DZxQSmyzKqZOP34PoCZVx4zAQoHZiYoo03hy3kEZRMTLH1eCF2mB+ttUo7ji+qUpVmI6+d4xDOmOyehLbRbeYI4yus+awx1rUIB5xGl2avVVnMJ8K8j5K/kRX0cObITyQofkM2RxASfjZJbWgjsvdw5shOJCh7QzZHEJJ9Pom35jHZuzijslPwj65S626qCgOEOI8UPonAYDWNDvl5dyYYmDkTksJn9kyU5Pcmo7G58zkG7t/cWbFk6M6JIzNnJGL8M3c2X3p0Z/SjM2f1VUmXiR/9Uib+YngJVaXjK57BCaqyx5c/k3h4EAOlkkfDUonqpUFGrWxpEIfqJ1dFDeJ0S6leZTVMVZdXrUrry7BDiFfJ0SBLV6UFirUgwiCbVklHW+Iux9GpxCNsuppEhqTXY8PlODpVgIRNV9fIriB0dWEXUJeFTYVIwuU9w8ZC0Xn162Gc+Hq0+6y5B7TqKLrDreINyETeLUBbqU+/sKwqzfp+InOaSz6ep/Vq1aZ2pdsJEeYRjwugMcXj8WSCG0NVDMWC7DmMEKOpeOoCr3/kdWVjrgx2pVUIkKvGQ8Ayc1NA4JhCnILrMg1K0cYBd31Q6uhXNlL5v8d6+4+q/al4H6j6Cdat9x0iz/GJAHauPB9HAMtrPyr4yoRYrC6XZi2PbpCe0VftOfeQ/UPVVrpcEN2IuASfcaaHC7Ua4e7pQj1D2CU4itS6e/vmzX+wcVgcpxuqKDBPfsrTs9+zWhuOv2+7hruQ/4V9xxjilMqr7egrpyvmD8IytxespmJGgTzcsmfBjrl6Zgf4WMVEIi3ZXL15XcXCzCeht8qIaKih2538g7Clzit2YL0d6gnuUA2VmqdfPomjm5wrE5ZHrgH4RYuRGLFyXp1mNsR+q8o8gby3xRcp92TjIwuojQTMhXgwal5d8V9az0vr+X+q9bw0m5dm89JsXprN05hLs7kPWZrNS7N5aTYvzeYwwdJsXprNS7N5aTYHKJZm8wjO0mxems1Ls7mHtjSbl2bz0mxems1Ls/n/t9ncvHn6S9Pnanclr7trVfP1Bhu6vS5iuO331OtrdJrZK2pid5WFDzO++0N71T+7BAB7B/dVV6f3VqvKo50UaeK6PqbFkmvNsRIGV5mZQM+ZmrhJqBuN7YkkkTgtTx/b87Xa/I1oTrJBfXz7B+rjB5ELLWN29/gwoJAEdl0GWrajq21bU8WgtfnVpCPLdL3cg0rc+9kxPm+n97RvVxv/+GHTeTazeW29uX3ZrLClqU/+Re9Sp0jKC7k5fbuhY+q/LvERNeWWWruD1qIOlh50kz7pqwMCjo4mCVHXH5pXse9feFakonk1unEUge8iON/gO751e7fVXmvIqbXVehbZ9LGqJ33Dj/Uu2MrduY51pf1mlXRKjRPg7Zu3363/sn57ZSHv+RF7b62cFg+PkbjWNXmI3MIycAb3BB10JtJU/XWvGomlQkl8gG409P7hE7Bwu4OaNrebzV7aQ7mF3DbbtFhsmqttqrYbXN3mx4d39//4eE+7gY/6Mp63mHtDcd62cneaVb8gwMK/INA6WVM/JlBZiBUvdlOklbZpLa+VsbZe2wcj6HX6brs/NYAH5ICPK4Hq9XXLjfis08sFh8HENH6tBy5PXEsXXMCqE2nouymr2x1PTT/UtFfy9YfqQH7DfucvEwQX6x0jdVqgtirxDi6P4tz7KYXLE6AfBMecA0V3GO+cgH/6hHwaDlcO7XLjKe5ibNKP4j61fMfj3ad3f1/hNzfcTyVk5LFWmuMza/xL4rov+5ALoLHXVcrzfYmZyu3KMSUXXuKeNl8icp7gxl/gsoIKgd0kjE+YvMKOev24ZBY0c7n8G8xVUlk=
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={"policies_event_matcher_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
path={"/policies/event_matcher/{policy_uuid}/"}
>
</MethodEndpoint>
Event Matcher Policy 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":"policy_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Event Matcher Policy.","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={"name"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"execution_logging"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"action"}
required={false}
schemaName={"EventActions (string)"}
qualifierMessage={"**Possible values:** [`login`, `login_failed`, `logout`, `user_write`, `suspicious_request`, `password_set`, `secret_view`, `secret_rotate`, `invitation_used`, `authorize_application`, `source_linked`, `impersonation_started`, `impersonation_ended`, `flow_execution`, `policy_execution`, `policy_exception`, `property_mapping_exception`, `system_task_execution`, `system_task_exception`, `system_exception`, `configuration_error`, `model_created`, `model_updated`, `model_deleted`, `email_sent`, `update_available`, `custom_`]"}
schema={{"enum":["login","login_failed","logout","user_write","suspicious_request","password_set","secret_view","secret_rotate","invitation_used","authorize_application","source_linked","impersonation_started","impersonation_ended","flow_execution","policy_execution","policy_exception","property_mapping_exception","system_task_execution","system_task_exception","system_exception","configuration_error","model_created","model_updated","model_deleted","email_sent","update_available","custom_"],"type":"string","title":"EventActions"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_ip"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","nullable":true,"minLength":1,"description":"Matches Event's Client IP (strict matching, for network matching use an Expression Policy)"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"app"}
required={false}
schemaName={"AppEnum (string)"}
qualifierMessage={"**Possible values:** [`authentik.tenants`, `authentik.admin`, `authentik.api`, `authentik.crypto`, `authentik.flows`, `authentik.outposts`, `authentik.policies.dummy`, `authentik.policies.event_matcher`, `authentik.policies.expiry`, `authentik.policies.expression`, `authentik.policies.geoip`, `authentik.policies.password`, `authentik.policies.reputation`, `authentik.policies`, `authentik.providers.ldap`, `authentik.providers.oauth2`, `authentik.providers.proxy`, `authentik.providers.radius`, `authentik.providers.saml`, `authentik.providers.scim`, `authentik.rbac`, `authentik.recovery`, `authentik.sources.ldap`, `authentik.sources.oauth`, `authentik.sources.plex`, `authentik.sources.saml`, `authentik.sources.scim`, `authentik.stages.authenticator`, `authentik.stages.authenticator_duo`, `authentik.stages.authenticator_sms`, `authentik.stages.authenticator_static`, `authentik.stages.authenticator_totp`, `authentik.stages.authenticator_validate`, `authentik.stages.authenticator_webauthn`, `authentik.stages.captcha`, `authentik.stages.consent`, `authentik.stages.deny`, `authentik.stages.dummy`, `authentik.stages.email`, `authentik.stages.identification`, `authentik.stages.invitation`, `authentik.stages.password`, `authentik.stages.prompt`, `authentik.stages.user_delete`, `authentik.stages.user_login`, `authentik.stages.user_logout`, `authentik.stages.user_write`, `authentik.brands`, `authentik.blueprints`, `authentik.core`, `authentik.enterprise`, `authentik.enterprise.audit`, `authentik.enterprise.providers.google_workspace`, `authentik.enterprise.providers.microsoft_entra`, `authentik.enterprise.providers.rac`, `authentik.enterprise.stages.source`, `authentik.events`]"}
schema={{"enum":["authentik.tenants","authentik.admin","authentik.api","authentik.crypto","authentik.flows","authentik.outposts","authentik.policies.dummy","authentik.policies.event_matcher","authentik.policies.expiry","authentik.policies.expression","authentik.policies.geoip","authentik.policies.password","authentik.policies.reputation","authentik.policies","authentik.providers.ldap","authentik.providers.oauth2","authentik.providers.proxy","authentik.providers.radius","authentik.providers.saml","authentik.providers.scim","authentik.rbac","authentik.recovery","authentik.sources.ldap","authentik.sources.oauth","authentik.sources.plex","authentik.sources.saml","authentik.sources.scim","authentik.stages.authenticator","authentik.stages.authenticator_duo","authentik.stages.authenticator_sms","authentik.stages.authenticator_static","authentik.stages.authenticator_totp","authentik.stages.authenticator_validate","authentik.stages.authenticator_webauthn","authentik.stages.captcha","authentik.stages.consent","authentik.stages.deny","authentik.stages.dummy","authentik.stages.email","authentik.stages.identification","authentik.stages.invitation","authentik.stages.password","authentik.stages.prompt","authentik.stages.user_delete","authentik.stages.user_login","authentik.stages.user_logout","authentik.stages.user_write","authentik.brands","authentik.blueprints","authentik.core","authentik.enterprise","authentik.enterprise.audit","authentik.enterprise.providers.google_workspace","authentik.enterprise.providers.microsoft_entra","authentik.enterprise.providers.rac","authentik.enterprise.stages.source","authentik.events"],"type":"string","title":"AppEnum"}}
>
</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>
</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={"pk"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Policy uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"execution_logging"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"component"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name_plural"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"meta_model_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return internal model name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"bound_to"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"Return objects policy is bound to","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"action"}
required={false}
schemaName={"EventActions (string)"}
qualifierMessage={"**Possible values:** [`login`, `login_failed`, `logout`, `user_write`, `suspicious_request`, `password_set`, `secret_view`, `secret_rotate`, `invitation_used`, `authorize_application`, `source_linked`, `impersonation_started`, `impersonation_ended`, `flow_execution`, `policy_execution`, `policy_exception`, `property_mapping_exception`, `system_task_execution`, `system_task_exception`, `system_exception`, `configuration_error`, `model_created`, `model_updated`, `model_deleted`, `email_sent`, `update_available`, `custom_`]"}
schema={{"enum":["login","login_failed","logout","user_write","suspicious_request","password_set","secret_view","secret_rotate","invitation_used","authorize_application","source_linked","impersonation_started","impersonation_ended","flow_execution","policy_execution","policy_exception","property_mapping_exception","system_task_execution","system_task_exception","system_exception","configuration_error","model_created","model_updated","model_deleted","email_sent","update_available","custom_"],"type":"string","title":"EventActions"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_ip"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","nullable":true,"description":"Matches Event's Client IP (strict matching, for network matching use an Expression Policy)"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"app"}
required={false}
schemaName={"AppEnum (string)"}
qualifierMessage={"**Possible values:** [`authentik.tenants`, `authentik.admin`, `authentik.api`, `authentik.crypto`, `authentik.flows`, `authentik.outposts`, `authentik.policies.dummy`, `authentik.policies.event_matcher`, `authentik.policies.expiry`, `authentik.policies.expression`, `authentik.policies.geoip`, `authentik.policies.password`, `authentik.policies.reputation`, `authentik.policies`, `authentik.providers.ldap`, `authentik.providers.oauth2`, `authentik.providers.proxy`, `authentik.providers.radius`, `authentik.providers.saml`, `authentik.providers.scim`, `authentik.rbac`, `authentik.recovery`, `authentik.sources.ldap`, `authentik.sources.oauth`, `authentik.sources.plex`, `authentik.sources.saml`, `authentik.sources.scim`, `authentik.stages.authenticator`, `authentik.stages.authenticator_duo`, `authentik.stages.authenticator_sms`, `authentik.stages.authenticator_static`, `authentik.stages.authenticator_totp`, `authentik.stages.authenticator_validate`, `authentik.stages.authenticator_webauthn`, `authentik.stages.captcha`, `authentik.stages.consent`, `authentik.stages.deny`, `authentik.stages.dummy`, `authentik.stages.email`, `authentik.stages.identification`, `authentik.stages.invitation`, `authentik.stages.password`, `authentik.stages.prompt`, `authentik.stages.user_delete`, `authentik.stages.user_login`, `authentik.stages.user_logout`, `authentik.stages.user_write`, `authentik.brands`, `authentik.blueprints`, `authentik.core`, `authentik.enterprise`, `authentik.enterprise.audit`, `authentik.enterprise.providers.google_workspace`, `authentik.enterprise.providers.microsoft_entra`, `authentik.enterprise.providers.rac`, `authentik.enterprise.stages.source`, `authentik.events`]"}
schema={{"enum":["authentik.tenants","authentik.admin","authentik.api","authentik.crypto","authentik.flows","authentik.outposts","authentik.policies.dummy","authentik.policies.event_matcher","authentik.policies.expiry","authentik.policies.expression","authentik.policies.geoip","authentik.policies.password","authentik.policies.reputation","authentik.policies","authentik.providers.ldap","authentik.providers.oauth2","authentik.providers.proxy","authentik.providers.radius","authentik.providers.saml","authentik.providers.scim","authentik.rbac","authentik.recovery","authentik.sources.ldap","authentik.sources.oauth","authentik.sources.plex","authentik.sources.saml","authentik.sources.scim","authentik.stages.authenticator","authentik.stages.authenticator_duo","authentik.stages.authenticator_sms","authentik.stages.authenticator_static","authentik.stages.authenticator_totp","authentik.stages.authenticator_validate","authentik.stages.authenticator_webauthn","authentik.stages.captcha","authentik.stages.consent","authentik.stages.deny","authentik.stages.dummy","authentik.stages.email","authentik.stages.identification","authentik.stages.invitation","authentik.stages.password","authentik.stages.prompt","authentik.stages.user_delete","authentik.stages.user_login","authentik.stages.user_logout","authentik.stages.user_write","authentik.brands","authentik.blueprints","authentik.core","authentik.enterprise","authentik.enterprise.audit","authentik.enterprise.providers.google_workspace","authentik.enterprise.providers.microsoft_entra","authentik.enterprise.providers.rac","authentik.enterprise.stages.source","authentik.events"],"type":"string","title":"AppEnum"}}
>
</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>
</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 \"execution_logging\": true,\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"bound_to\": 0,\n \"action\": \"login\",\n \"client_ip\": \"string\",\n \"app\": \"authentik.tenants\",\n \"model\": \"authentik_tenants.domain\"\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>