502 lines
44 KiB
Plaintext
502 lines
44 KiB
Plaintext
---
|
|
id: policies-event-matcher-create
|
|
title: "policies_event_matcher_create"
|
|
description: "Event Matcher Policy Viewset"
|
|
sidebar_label: "policies_event_matcher_create"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXN2P27gR/1cEvVwLuHaSu4din5oLFocAlyZI7q4Ph4VAS7TNs0SqJLW77sL/e2eGor5MfaQIULTQw+5K5G+GQ3I4Hxx7X2JVcs2sUPJ9Ft/FpcpFKrhJ+COXNimYTU9cJ6nmzPJ4E2fcpFqUiAf0PYKiDw4UfULaS/Sb4E+GWwBbdjTx3e8N0/hhE2v+z4ob+6PKLvHdS5wqaYEHPrKyBBiJsvvDIP+X2ADjguGTvZQcRlT7P3hqlwnyhWvBcvEvrgFfapyoRSmAm2QF73A1Vgt5BFQh5M9cHu0pvnt93cT8macVDpHk6nhESEuzVyrnTN6I8o8Tl5E9CRMpaorgiUu2z3m2iVieRw1TQBwcsnQCPwno3vMIB+PZNvrxEmX8wKrcbiIl80tLGnGtlTYR0w06BnlZ6oSAxczzjwdY+5eYy6rATQCYQGnpb3JgAgRyr6rCBa0M7POTFrTNpjIlbJmqTFJvGC4hM+ZJ6Sxxu2s4aIVNHmG72zetrFMUIR+Fpc1MgDOOxCp7Uhq2I+nsNFKqSqc8yYU8E04UsFGw/47YWKZtoJ3LjFoPuXpKmnVBKWktw00pL32TU4cLaHhZwsb2Os3FWF4klplzj0+//QbfbQK9PohjpWthcbdQvVTG8/owZc17VWa9d/jh7h10X+Sw3JI2iGAJe4Q2VCccpTJWFQmeq6EmW2Fz7k/GW9ILE18BKKvckd9ZXfGh9tIRimoJIzICBvTSnpyiOgWLcLBtRJqe84ONeFHai9PuDsI0Cu3MiNPRNBdoWUQZOn9D4brnMSgqDEIz/M5E74hx9P5T9Cfkl1o3LDDeRAelI8ktaO+5aY1ALyMmo/vnUnNjUGpnOP5MR6ksw+cI1RjGEectGC4Gy1OrtmtjWUGnrNNSit57qi+lVb0m1OE+GziSpTID3t6MbrOqKC7hrp7ZHoE8l0KPkTdrEe4/cgUbF+zy1iHcq3lZWX/ib/v7jVo9igzO+jbPWDnSpbDxzUgnPD1fRvo0y0Q1NqBhRT7WlYqi16X3LO038FQ98sHSOusWmIrvoIkEe8qcPwc7bqRsOoYygvU8QrtvAJur9CwgySo1DzKFWQDCPU/ncVbZch71CN48c+5lBvnE99ggQ8iUlXA6WLALjKQztjddGZeXYPvNWaw7yHaHOkCd4PXQOsBbROM7Q73Bg+b7tAJTHOoh9+48y2i3DxFGe12kEO72oUPbu9dMZn0l2ecVL8HWDyxbqnSfFH5zDUAz1gz7nQk71tme2qNSx5wnaPhNydJRdi1FIVKtjDpYCDGsZvMEemAGOqB6fdzx7IPIs0457rdleY8uZ6nPrn21d937S2Rgt1N87sRbY167RbigsuuxKSqZcYZJ7Qy3mQK97ylR4jzeNsXwm9Sen/mlZKJniRJyguQKR5ppMfdCZm6dWoh3ljB2eoYd4fpRpGCLpeTp8BC14HO15xpiAnB3ywjqh15nky6RGXDGwEWbYVjPPTslqF8mqchjNwffvc4Q1G6849GnCMivO+8+BfMSNKJMgVuX3/H+EwQuGLiEdrg5bAm6UfKlvmkE58IDcIgQ5tch/jTS/ZnhSnGFiy5mkC7KqION/wTrE5Rp4TESoHBgZogubglbiCMomJhj63EhdhgfbbXKe4YvqUOVdiNvjeMYZkp2T0Lb6DZzgvENajlr9HUdwhGj0ac5alWVy4kw7qPgb2IGA8wS+YkExW/JlghCwi8maRRtQvYBZonsRIKyt2RLBCHZl5N4bZ6SvY+ZlJ2cf3ITWvdDVWgg4DJS+Mk4Oqt5OMTn/ZGgYeFISAo/i0eiIH8wGLUtHc8xcH+WjoopQ39MbFk4IhHjr6Wj+dSjP6JvXTiqz0r6THzr1zLxD+NTqDMdn/GMDlCnPT79mcXhQQykSh6GqRLlS6OMOtHSKIbyJ5dFjWL6qdQgsxqnatKrTqb1degQ8CY4GmXpsrRAshYEjLLppHS0Je5xGk4pHqHpaRYMQa9Hw+M0nDJAQtPTLdglhC4v7Hc0aWGbIZJwcqDYmCg6q37bjAPftvbvmgedVp15v7mTvAEZl/0EtBP6DBPLOtNs3mcip6Xk03HaIFdtc1d6nRFhGfG0ABpDPJbOBrgpZMWQLIiBwQgxmvOnzvH6K68bHXNpsEutQh1StRYCpilNCY5jDjjXr6s8KEUXA+b6pNTZz2wi8/+A+fa3yv0peR/J+qmvn+87IJN4I4CVK8/HEcD0ulcF35kQi/h6dWU+oXmGlwRUbHsYlCTqWp27cf9c15iufVKc8JVKSxUYlAvdPDRrDG8PVyoowhbCOaW63ptXr/+LVcXyHKppHBQcIpAlriqBZg82Kfso84vfUL8sNX9CwazDJcr/waJkCk5MyXo7hovTF/MnbiO3F1FDFRkF8jAbPfHoLNVTdIIfqyKeCUsK2Wxef2Fh5Eeu98rwZKza2x/8M7eVljU7UO0e9Qx3SJUqzfKvH8TRzY5VcMsSVx38qskIdGeS1Uc9GmO/V5XMICju8EXKI+n4xAQaJQF1IR4RVbZu+K916bUu/X9Vl14r0Wsleq1Er5XoeeRaiR72rJXotRK9VqLXSnSYYK1Er5XotRK9VqIDFGslegKzVqLXSvRaiR7A1kr0WoleK9FrJXqtRK+VaLwkaOpc3arkbXWtLr5usKA7qCKGy36TxW1X1e4vFl5m/PDq1TesVf/mAgCsHdzXVZ3BV16VTA6C55mr+pgOS6Y1w0wYTGVhAjVnKuJmoWo0lieyTOCwLP/UHe/aLkkrmpNsdD2+/4br8ROXXIs0evvp/ciCZLDrIlCynZxtV5tqBp3NrwedmKar5Z6U+651Xb7ErzfGO3/7sOtdzexirGFq0DpD912VzhHMSrF7/H5H59J/PuILLo2bW3P+O7M4WbrZpgWkzwpwOCuaRMLF/dx+Mfv+mRVlztsvSreWIfDhA2cMfIm3qed26mktOdWyOpePbeGqvtobv8e7Yu324ErU9XK3s6RjaZwAb169+WH71+3rG5X4wM5YbOsEsXhajMC5bskkSAvTwBHclTmsGc9z9bejaiUWCiXxHrldoQ/vfwEWbndwpc3dbncU9lTtIZgtdh0Wu/Zpn6v9Dme3+/n9u/u/f7mn3UC9KJjsMPeq4cxrbd90FP5WfucIzX5B32mG5c92V+b1KtMcXmq17Hx5HzZ/UNJD1T+hEgPs5WXPDP9V59crNoMuafzADjw+Mi2c2/j9AdifOEP/jLp85gCJ3zlp//ILCoNwiLtwc4eH/7rxFG9TLGhPYh865+zTxy+4N/v6Xw4UdLhjzfB6F3/DudzE7nMxdHio7SXOmTxW6NTvYseTrF2Fq9J+3sadoY1/wFl5o0pVGi8hLA8hfsE4D5ZoU0/FxX3XB2D+b5+w0Oo=
|
|
sidebar_class_name: "post 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={"policies_event_matcher_create"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/policies/event_matcher/"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Event Matcher Policy Viewset
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<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={"name"}
|
|
required={true}
|
|
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={"201"}
|
|
value={"201"}
|
|
>
|
|
<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>
|
|
|