Authentik

Authentik Property Mappings API

Property mappings — the expressions that shape claims, attributes and payloads for every provider and source type, plus notification webhook bodies.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 111

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /propertymappings/all/ List property mappings of every type · Propertymappings all list #
Ask an LLM
“What property mappings exist across all types in my authentik instance?”
“Can I see only the built-in managed mappings, whatever kind they are?”
Tell an agent
List every property mapping regardless of type.
Search all property mappings of any type for {term}.
GET /propertymappings/all/{pm_uuid}/ Get any property mapping by ID · Propertymappings all retrieve #
Ask an LLM
“How do I look up a property mapping when I only have its UUID and not its type?”
“Which type and expression does an unknown mapping ID resolve to?”
Tell an agent
Show the generic property mapping record for {mapping_id}.
Look up mapping {mapping_id} without knowing which kind it is.
DELETE /propertymappings/all/{pm_uuid}/ Delete any property mapping by ID · Propertymappings all destroy #
Ask an LLM
“Can I delete a property mapping through the generic endpoint without knowing its type?”
“Is there a single call that removes a mapping of any kind?”
Tell an agent destructive · confirm first
Delete property mapping {mapping_id} via the all-types endpoint.
Remove mapping {mapping_id}, whatever type it is.
POST /propertymappings/all/{pm_uuid}/test/ Test a property mapping against a user · Propertymappings all test create #
Ask an LLM
“How do I preview what a property mapping expression returns for a given user?”
“Can I dry-run a mapping against a group or custom context before attaching it?”
Tell an agent
Test property mapping {mapping_id} against user {user}.
Evaluate mapping {mapping_id} for group {group} and format the result.
GET /propertymappings/all/{pm_uuid}/used_by/ See what uses any property mapping · Propertymappings all used by list #
Ask an LLM
“Which providers or sources reference a mapping, looked up by its UUID alone?”
“Would anything break if I removed a mapping of an unknown type?”
Tell an agent
Show every object that depends on mapping {mapping_id} using the all-types lookup.
Check what still references generic mapping {mapping_id}.
GET /propertymappings/all/types/ List creatable property mapping types · Propertymappings all types list #
Ask an LLM
“What kinds of property mappings can I create in authentik?”
“Which mapping types are available to choose from when adding a new one?”
Tell an agent
List all the property mapping types I can create.
Show the available mapping kinds with their component names.
GET /propertymappings/notification/ List notification webhook mappings · Propertymappings notification list #
Ask an LLM
“Which webhook mappings shape the payload of my notification transports?”
“Can I filter notification webhook mappings by name?”
Tell an agent
List my notification webhook mappings.
Find the notification webhook mapping called {name}.
POST /propertymappings/notification/ Create a notification webhook mapping · Propertymappings notification create #
Ask an LLM
“How do I customize the JSON body a notification webhook sends?”
“Can I add a new webhook mapping with my own Python expression for alerts?”
Tell an agent
Create a notification webhook mapping {name} with expression {expression}.
Add a new webhook payload mapping named {name} that returns {expression}.
GET /propertymappings/notification/{pm_uuid}/ Get a notification webhook mapping · Propertymappings notification retrieve #
Ask an LLM
“What expression does a particular notification webhook mapping run?”
“Can I view the details of one webhook payload mapping?”
Tell an agent
Show notification webhook mapping {mapping_id}.
Get the expression of webhook mapping {mapping_id}.
PUT /propertymappings/notification/{pm_uuid}/ Replace a notification webhook mapping · Propertymappings notification update #
Ask an LLM
“How do I overwrite both the name and expression of a webhook mapping at once?”
“Can I fully replace an existing notification webhook mapping definition?”
Tell an agent
Replace webhook mapping {mapping_id} with name {name} and expression {expression}.
Overwrite notification mapping {mapping_id} entirely, naming it {name}.
PATCH /propertymappings/notification/{pm_uuid}/ Edit part of a notification webhook mapping · Propertymappings notification partial update #
Ask an LLM
“Can I change only the expression of a notification webhook mapping?”
“Is it possible to rename a webhook mapping without resending its expression?”
Tell an agent
Change just the expression of webhook mapping {mapping_id} to {expression}.
Rename notification webhook mapping {mapping_id} to {name}, leaving the rest.
DELETE /propertymappings/notification/{pm_uuid}/ Delete a notification webhook mapping · Propertymappings notification destroy #
Ask an LLM
“How do I remove a webhook payload mapping I no longer use?”
“Can I delete a notification webhook mapping for good?”
Tell an agent destructive · confirm first
Delete notification webhook mapping {mapping_id}.
Remove the webhook payload mapping {mapping_id}.
GET /propertymappings/notification/{pm_uuid}/used_by/ See what uses a notification webhook mapping · Propertymappings notification used by list #
Ask an LLM
“Which notification transports rely on this webhook mapping?”
“Is a given webhook payload mapping still in use anywhere?”
Tell an agent
List the objects that use notification webhook mapping {mapping_id}.
Check whether webhook mapping {mapping_id} is referenced by any transport.
GET /propertymappings/provider/google_workspace/ List Google Workspace provider mappings · Propertymappings provider google workspace list #
Ask an LLM
“Which mappings control how users sync out to Google Workspace?”
“Can I filter Google Workspace provisioning mappings by expression or managed status?”
Tell an agent
List my Google Workspace provider mappings.
Find Google Workspace provisioning mappings named {name}.
POST /propertymappings/provider/google_workspace/ Create a Google Workspace provider mapping · Propertymappings provider google workspace create #
Ask an LLM
“How do I add a custom attribute mapping for provisioning users into Google Workspace?”
“Can I write my own expression to shape the Google Workspace user payload?”
Tell an agent
Create a Google Workspace provider mapping {name} with expression {expression}.
Add a new Google Workspace provisioning mapping called {name}.
GET /propertymappings/provider/google_workspace/{pm_uuid}/ Get a Google Workspace provider mapping · Propertymappings provider google workspace retrieve #
Ask an LLM
“What does a specific Google Workspace provisioning mapping send?”
“Is this Google Workspace mapping one of the built-in managed ones?”
Tell an agent
Show Google Workspace provider mapping {mapping_id}.
Get the expression behind Google Workspace mapping {mapping_id}.
PUT /propertymappings/provider/google_workspace/{pm_uuid}/ Replace a Google Workspace provider mapping · Propertymappings provider google workspace update #
Ask an LLM
“How do I fully overwrite a Google Workspace provisioning mapping?”
“Can I resubmit the whole definition of a Google Workspace mapping in one go?”
Tell an agent
Replace Google Workspace mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the full Google Workspace provider mapping {mapping_id}.
PATCH /propertymappings/provider/google_workspace/{pm_uuid}/ Edit part of a Google Workspace provider mapping · Propertymappings provider google workspace partial update #
Ask an LLM
“Can I tweak only the expression of a Google Workspace mapping?”
“Is there a way to rename a Google Workspace provisioning mapping without touching its code?”
Tell an agent
Update just the expression of Google Workspace mapping {mapping_id} to {expression}.
Rename Google Workspace mapping {mapping_id} to {name} only.
DELETE /propertymappings/provider/google_workspace/{pm_uuid}/ Delete a Google Workspace provider mapping · Propertymappings provider google workspace destroy #
Ask an LLM
“How do I get rid of a Google Workspace provisioning mapping?”
“Can I delete a custom mapping from my Google Workspace sync?”
Tell an agent destructive · confirm first
Delete Google Workspace provider mapping {mapping_id}.
Remove the Google Workspace sync mapping {mapping_id}.
GET /propertymappings/provider/google_workspace/{pm_uuid}/used_by/ See what uses a Google Workspace provider mapping · Propertymappings provider google workspace used by list #
Ask an LLM
“Which Google Workspace providers use this mapping?”
“Is a given Google Workspace mapping safe to delete?”
Tell an agent
List what references Google Workspace mapping {mapping_id}.
Check which providers depend on Google Workspace mapping {mapping_id}.
GET /propertymappings/provider/microsoft_entra/ List Microsoft Entra provider mappings · Propertymappings provider microsoft entra list #
Ask an LLM
“Which mappings control how users are provisioned into Microsoft Entra ID?”
“Can I search my Entra provisioning mappings by expression text?”
Tell an agent
List my Microsoft Entra provider mappings.
Find Entra provisioning mappings matching {term}.
POST /propertymappings/provider/microsoft_entra/ Create a Microsoft Entra provider mapping · Propertymappings provider microsoft entra create #
Ask an LLM
“How do I add a custom attribute mapping for syncing users to Microsoft Entra?”
“Can I define my own expression for the Entra ID user payload?”
Tell an agent
Create a Microsoft Entra provider mapping {name} with expression {expression}.
Add a new Entra ID sync mapping called {name}.
GET /propertymappings/provider/microsoft_entra/{pm_uuid}/ Get a Microsoft Entra provider mapping · Propertymappings provider microsoft entra retrieve #
Ask an LLM
“What does a particular Microsoft Entra provisioning mapping send?”
“Can I read the expression of one Entra ID mapping?”
Tell an agent
Show Microsoft Entra provider mapping {mapping_id}.
Get the details of Entra mapping {mapping_id}.
PUT /propertymappings/provider/microsoft_entra/{pm_uuid}/ Replace a Microsoft Entra provider mapping · Propertymappings provider microsoft entra update #
Ask an LLM
“How do I fully overwrite a Microsoft Entra provisioning mapping?”
“Can I resend the entire Entra mapping definition to replace it?”
Tell an agent
Replace Entra mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole Microsoft Entra provider mapping {mapping_id}.
PATCH /propertymappings/provider/microsoft_entra/{pm_uuid}/ Edit part of a Microsoft Entra provider mapping · Propertymappings provider microsoft entra partial update #
Ask an LLM
“Can I change only the expression of an Entra provisioning mapping?”
“Is it possible to rename a Microsoft Entra mapping and leave its code alone?”
Tell an agent
Update just the expression of Entra mapping {mapping_id} to {expression}.
Rename Microsoft Entra mapping {mapping_id} to {name} only.
DELETE /propertymappings/provider/microsoft_entra/{pm_uuid}/ Delete a Microsoft Entra provider mapping · Propertymappings provider microsoft entra destroy #
Ask an LLM
“How do I remove a Microsoft Entra provisioning mapping?”
“Can I delete a custom mapping from my Entra ID sync?”
Tell an agent destructive · confirm first
Delete Microsoft Entra provider mapping {mapping_id}.
Remove the Entra ID sync mapping {mapping_id}.
GET /propertymappings/provider/microsoft_entra/{pm_uuid}/used_by/ See what uses a Microsoft Entra provider mapping · Propertymappings provider microsoft entra used by list #
Ask an LLM
“Which Microsoft Entra providers use this mapping?”
“Is a given Entra mapping still referenced before I delete it?”
Tell an agent
List what references Entra mapping {mapping_id}.
Check which providers depend on Microsoft Entra mapping {mapping_id}.
GET /propertymappings/provider/rac/ List RAC remote access property mappings · Propertymappings provider rac list #
Ask an LLM
“Which property mappings configure my remote access (RAC) connections?”
“Can I list only the managed RAC mappings?”
Tell an agent
List my RAC property mappings.
Find RAC remote access mappings named {name}.
POST /propertymappings/provider/rac/ Create a RAC remote access property mapping · Propertymappings provider rac create #
Ask an LLM
“How do I set static connection settings for remote access endpoints with a mapping?”
“Can a new RAC mapping combine static settings with an optional expression?”
Tell an agent
Create a RAC property mapping {name} with static settings {static_settings}.
Add RAC mapping {name} using settings {static_settings} and expression {expression}.
GET /propertymappings/provider/rac/{pm_uuid}/ Get a RAC remote access property mapping · Propertymappings provider rac retrieve #
Ask an LLM
“What static settings does a particular RAC mapping apply to connections?”
“Can I view a single remote access property mapping?”
Tell an agent
Show RAC property mapping {mapping_id}.
Get the static settings of RAC mapping {mapping_id}.
PUT /propertymappings/provider/rac/{pm_uuid}/ Replace a RAC remote access property mapping · Propertymappings provider rac update #
Ask an LLM
“How do I overwrite a RAC mapping's name and static settings together?”
“Can I resubmit a full remote access mapping definition to replace it?”
Tell an agent
Replace RAC mapping {mapping_id} with name {name} and static settings {static_settings}.
Overwrite the whole RAC property mapping {mapping_id}.
PATCH /propertymappings/provider/rac/{pm_uuid}/ Edit part of a RAC remote access property mapping · Propertymappings provider rac partial update #
Ask an LLM
“Can I change just the static settings on a RAC mapping?”
“Is it possible to update only the expression of a remote access mapping?”
Tell an agent
Update only the static settings of RAC mapping {mapping_id} to {static_settings}.
Change just the expression on RAC mapping {mapping_id} to {expression}.
DELETE /propertymappings/provider/rac/{pm_uuid}/ Delete a RAC remote access property mapping · Propertymappings provider rac destroy #
Ask an LLM
“How do I remove a remote access property mapping?”
“Can I delete a RAC mapping I no longer need?”
Tell an agent destructive · confirm first
Delete RAC property mapping {mapping_id}.
Remove the remote access mapping {mapping_id}.
GET /propertymappings/provider/rac/{pm_uuid}/used_by/ See what uses a RAC remote access mapping · Propertymappings provider rac used by list #
Ask an LLM
“Which RAC providers or endpoints use this property mapping?”
“Is a remote access mapping still attached to anything?”
Tell an agent
List what references RAC mapping {mapping_id}.
Check which endpoints depend on remote access mapping {mapping_id}.
GET /propertymappings/provider/radius/ List RADIUS provider property mappings · Propertymappings provider radius list #
Ask an LLM
“Which property mappings add attributes to my RADIUS responses?”
“Can I filter RADIUS mappings to the non-managed ones I wrote myself?”
Tell an agent
List my RADIUS provider property mappings.
Find RADIUS mappings named {name}.
POST /propertymappings/provider/radius/ Create a RADIUS provider property mapping · Propertymappings provider radius create #
Ask an LLM
“How do I return custom RADIUS attributes with an expression?”
“Can I add a new property mapping for my RADIUS provider?”
Tell an agent
Create a RADIUS property mapping {name} with expression {expression}.
Add a new RADIUS attribute mapping called {name}.
GET /propertymappings/provider/radius/{pm_uuid}/ Get a RADIUS provider property mapping · Propertymappings provider radius retrieve #
Ask an LLM
“What expression does a particular RADIUS mapping evaluate?”
“Can I view one RADIUS provider property mapping?”
Tell an agent
Show RADIUS property mapping {mapping_id}.
Get the expression of RADIUS mapping {mapping_id}.
PUT /propertymappings/provider/radius/{pm_uuid}/ Replace a RADIUS provider property mapping · Propertymappings provider radius update #
Ask an LLM
“How do I fully overwrite a RADIUS property mapping?”
“Can I replace the whole definition of a RADIUS attribute mapping?”
Tell an agent
Replace RADIUS mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole RADIUS property mapping {mapping_id}.
PATCH /propertymappings/provider/radius/{pm_uuid}/ Edit part of a RADIUS provider property mapping · Propertymappings provider radius partial update #
Ask an LLM
“Can I change only the expression of a RADIUS mapping?”
“Is it possible to rename a RADIUS property mapping without resending the rest?”
Tell an agent
Update just the expression of RADIUS mapping {mapping_id} to {expression}.
Rename RADIUS mapping {mapping_id} to {name} only.
DELETE /propertymappings/provider/radius/{pm_uuid}/ Delete a RADIUS provider property mapping · Propertymappings provider radius destroy #
Ask an LLM
“How do I remove a RADIUS attribute mapping?”
“Can I delete a RADIUS property mapping for good?”
Tell an agent destructive · confirm first
Delete RADIUS property mapping {mapping_id}.
Remove the RADIUS attribute mapping {mapping_id}.
GET /propertymappings/provider/radius/{pm_uuid}/used_by/ See what uses a RADIUS provider mapping · Propertymappings provider radius used by list #
Ask an LLM
“Which RADIUS providers use this property mapping?”
“Is a RADIUS attribute mapping still referenced before I remove it?”
Tell an agent
List what references RADIUS mapping {mapping_id}.
Check which providers depend on RADIUS mapping {mapping_id}.
GET /propertymappings/provider/saml/ List SAML provider property mappings · Propertymappings provider saml list #
Ask an LLM
“Which attribute mappings go into the SAML assertions my apps receive?”
“Can I filter SAML provider mappings by SAML attribute name or friendly name?”
Tell an agent
List my SAML provider property mappings.
Find SAML provider mappings that emit attribute {saml_name}.
POST /propertymappings/provider/saml/ Create a SAML provider property mapping · Propertymappings provider saml create #
Ask an LLM
“How do I add a custom attribute to outgoing SAML assertions?”
“Can I give a new SAML assertion attribute a friendly name too?”
Tell an agent
Create a SAML provider mapping {name} that sets attribute {saml_name} to {expression}.
Add assertion mapping {name} for SAML attribute {saml_name} with friendly name {friendly_name}.
GET /propertymappings/provider/saml/{pm_uuid}/ Get a SAML provider property mapping · Propertymappings provider saml retrieve #
Ask an LLM
“Which SAML attribute name does a particular assertion mapping produce?”
“Can I view one SAML provider mapping's expression?”
Tell an agent
Show SAML provider mapping {mapping_id}.
Get the assertion attribute and expression of SAML provider mapping {mapping_id}.
PUT /propertymappings/provider/saml/{pm_uuid}/ Replace a SAML provider property mapping · Propertymappings provider saml update #
Ask an LLM
“How do I overwrite an assertion mapping's name, SAML attribute and expression together?”
“Can I fully replace a SAML provider mapping definition?”
Tell an agent
Replace SAML provider mapping {mapping_id} with name {name}, attribute {saml_name} and expression {expression}.
Overwrite the whole SAML assertion mapping {mapping_id}.
PATCH /propertymappings/provider/saml/{pm_uuid}/ Edit part of a SAML provider property mapping · Propertymappings provider saml partial update #
Ask an LLM
“Can I change just the friendly name on a SAML assertion mapping?”
“Is it possible to rename the SAML attribute without resending the expression?”
Tell an agent
Set only the friendly name of SAML provider mapping {mapping_id} to {friendly_name}.
Change just the SAML attribute name on mapping {mapping_id} to {saml_name}.
DELETE /propertymappings/provider/saml/{pm_uuid}/ Delete a SAML provider property mapping · Propertymappings provider saml destroy #
Ask an LLM
“How do I stop sending an attribute in SAML assertions by deleting its mapping?”
“Can I remove a SAML provider mapping entirely?”
Tell an agent destructive · confirm first
Delete SAML provider mapping {mapping_id}.
Remove the SAML assertion attribute mapping {mapping_id}.
GET /propertymappings/provider/saml/{pm_uuid}/used_by/ See what uses a SAML provider mapping · Propertymappings provider saml used by list #
Ask an LLM
“Which SAML providers include this assertion mapping?”
“Is a SAML provider mapping still attached to any application?”
Tell an agent
List what references SAML provider mapping {mapping_id}.
Check which SAML providers depend on assertion mapping {mapping_id}.
GET /propertymappings/provider/scim/ List SCIM provider mappings · Propertymappings provider scim list #
Ask an LLM
“Which mappings shape the users and groups I push to apps over SCIM?”
“Can I find outbound SCIM mappings by name?”
Tell an agent
List my SCIM provider mappings for outbound provisioning.
Find SCIM provider mappings named {name}.
POST /propertymappings/provider/scim/ Create a SCIM provider mapping · Propertymappings provider scim create #
Ask an LLM
“How do I customize the SCIM payload sent when provisioning users to an app?”
“Can I add my own expression for outbound SCIM attributes?”
Tell an agent
Create a SCIM provider mapping {name} with expression {expression}.
Add a new outbound SCIM mapping called {name}.
GET /propertymappings/provider/scim/{pm_uuid}/ Get a SCIM provider mapping · Propertymappings provider scim retrieve #
Ask an LLM
“What does a particular outbound SCIM mapping send to the app?”
“Can I view one SCIM provider mapping's expression?”
Tell an agent
Show SCIM provider mapping {mapping_id}.
Get the expression of outbound SCIM mapping {mapping_id}.
PUT /propertymappings/provider/scim/{pm_uuid}/ Replace a SCIM provider mapping · Propertymappings provider scim update #
Ask an LLM
“How do I fully overwrite an outbound SCIM provisioning mapping?”
“Can I replace the whole SCIM provider mapping definition at once?”
Tell an agent
Replace SCIM provider mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole outbound SCIM mapping {mapping_id}.
PATCH /propertymappings/provider/scim/{pm_uuid}/ Edit part of a SCIM provider mapping · Propertymappings provider scim partial update #
Ask an LLM
“Can I change only the expression of an outbound SCIM mapping?”
“Is it possible to rename a SCIM provider mapping and keep its code?”
Tell an agent
Update just the expression of SCIM provider mapping {mapping_id} to {expression}.
Rename outbound SCIM mapping {mapping_id} to {name} only.
DELETE /propertymappings/provider/scim/{pm_uuid}/ Delete a SCIM provider mapping · Propertymappings provider scim destroy #
Ask an LLM
“How do I remove an outbound SCIM provisioning mapping?”
“Can I delete a SCIM provider mapping I no longer use?”
Tell an agent destructive · confirm first
Delete SCIM provider mapping {mapping_id}.
Remove the outbound SCIM mapping {mapping_id}.
GET /propertymappings/provider/scim/{pm_uuid}/used_by/ See what uses a SCIM provider mapping · Propertymappings provider scim used by list #
Ask an LLM
“Which SCIM providers use this outbound mapping?”
“Is an outbound SCIM mapping still referenced anywhere?”
Tell an agent
List what references SCIM provider mapping {mapping_id}.
Check which SCIM providers depend on outbound mapping {mapping_id}.
GET /propertymappings/provider/scope/ List OAuth2 scope mappings · Propertymappings provider scope list #
Ask an LLM
“Which OAuth2 scopes can my apps request and what claims do they return?”
“Can I filter scope mappings by scope name, like email or profile?”
Tell an agent
List my OAuth2 scope mappings.
Find the scope mapping for scope {scope_name}.
POST /propertymappings/provider/scope/ Create an OAuth2 scope mapping · Propertymappings provider scope create #
Ask an LLM
“How do I add a custom OAuth2 scope that returns extra claims?”
“Can I give a new scope a description shown to users on consent?”
Tell an agent
Create scope mapping {name} for scope {scope_name} returning {expression}.
Add OAuth2 scope {scope_name} named {name} with consent description {description}.
GET /propertymappings/provider/scope/{pm_uuid}/ Get an OAuth2 scope mapping · Propertymappings provider scope retrieve #
Ask an LLM
“What claims does a particular scope mapping add to tokens?”
“Can I view one OAuth2 scope mapping and its description?”
Tell an agent
Show scope mapping {mapping_id}.
Get the expression and scope name of scope mapping {mapping_id}.
PUT /propertymappings/provider/scope/{pm_uuid}/ Replace an OAuth2 scope mapping · Propertymappings provider scope update #
Ask an LLM
“How do I overwrite a scope mapping's name, scope and expression together?”
“Can I fully replace an OAuth2 scope mapping definition?”
Tell an agent
Replace scope mapping {mapping_id} with name {name}, scope {scope_name} and expression {expression}.
Overwrite the whole OAuth2 scope mapping {mapping_id}.
PATCH /propertymappings/provider/scope/{pm_uuid}/ Edit part of an OAuth2 scope mapping · Propertymappings provider scope partial update #
Ask an LLM
“Can I change only the consent description of a scope?”
“Is it possible to update a scope mapping's claims expression by itself?”
Tell an agent
Set only the description of scope mapping {mapping_id} to {description}.
Change just the claims expression of scope mapping {mapping_id} to {expression}.
DELETE /propertymappings/provider/scope/{pm_uuid}/ Delete an OAuth2 scope mapping · Propertymappings provider scope destroy #
Ask an LLM
“How do I remove a custom OAuth2 scope?”
“Can I delete a scope mapping so apps can no longer request it?”
Tell an agent destructive · confirm first
Delete scope mapping {mapping_id}.
Remove the OAuth2 scope mapping {mapping_id}.
GET /propertymappings/provider/scope/{pm_uuid}/used_by/ See what uses an OAuth2 scope mapping · Propertymappings provider scope used by list #
Ask an LLM
“Which OAuth2 providers offer this scope mapping?”
“Is a scope mapping still used before I delete it?”
Tell an agent
List what references scope mapping {mapping_id}.
Check which OAuth2 providers depend on scope mapping {mapping_id}.
GET /propertymappings/source/kerberos/ List Kerberos source property mappings · Propertymappings source kerberos list #
Ask an LLM
“Which mappings turn Kerberos principals into authentik user attributes?”
“Can I list only the custom Kerberos source mappings, not the managed ones?”
Tell an agent
List my Kerberos source property mappings.
Find Kerberos source mappings named {name}.
POST /propertymappings/source/kerberos/ Create a Kerberos source property mapping · Propertymappings source kerberos create #
Ask an LLM
“What do I need to add a mapping that sets user fields from a Kerberos realm?”
“Can I write my own expression for users imported from Kerberos?”
Tell an agent
Create a Kerberos source mapping {name} with expression {expression}.
Add a new Kerberos attribute mapping called {name}.
GET /propertymappings/source/kerberos/{pm_uuid}/ Get a Kerberos source property mapping · Propertymappings source kerberos retrieve #
Ask an LLM
“What does a particular Kerberos source mapping set on the user?”
“Can I view one Kerberos mapping's expression?”
Tell an agent
Show Kerberos source mapping {mapping_id}.
Get the expression of Kerberos mapping {mapping_id}.
PUT /propertymappings/source/kerberos/{pm_uuid}/ Replace a Kerberos source property mapping · Propertymappings source kerberos update #
Ask an LLM
“Can I fully overwrite a Kerberos source mapping's name and expression?”
“Is there a way to resubmit a whole Kerberos mapping to replace it?”
Tell an agent
Replace Kerberos mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole Kerberos source mapping {mapping_id}.
PATCH /propertymappings/source/kerberos/{pm_uuid}/ Edit part of a Kerberos source property mapping · Propertymappings source kerberos partial update #
Ask an LLM
“Can I change only the expression on a Kerberos mapping?”
“Is renaming a Kerberos source mapping possible without resending its code?”
Tell an agent
Update just the expression of Kerberos mapping {mapping_id} to {expression}.
Rename Kerberos source mapping {mapping_id} to {name} only.
DELETE /propertymappings/source/kerberos/{pm_uuid}/ Delete a Kerberos source property mapping · Propertymappings source kerberos destroy #
Ask an LLM
“How do I remove a Kerberos source mapping?”
“Can I delete a custom Kerberos attribute mapping?”
Tell an agent destructive · confirm first
Delete Kerberos source mapping {mapping_id}.
Remove the Kerberos attribute mapping {mapping_id}.
GET /propertymappings/source/kerberos/{pm_uuid}/used_by/ See what uses a Kerberos source mapping · Propertymappings source kerberos used by list #
Ask an LLM
“Which Kerberos sources use this mapping?”
“Is a Kerberos attribute mapping still referenced by any realm?”
Tell an agent
List what references Kerberos mapping {mapping_id}.
Check which Kerberos sources depend on mapping {mapping_id}.
GET /propertymappings/source/ldap/ List LDAP source property mappings · Propertymappings source ldap list #
Ask an LLM
“Which mappings copy LDAP directory attributes onto synced users and groups?”
“Can I search my LDAP source mappings, for example for mail or displayName?”
Tell an agent
List my LDAP source property mappings.
Search LDAP source mappings for {term}.
POST /propertymappings/source/ldap/ Create an LDAP source property mapping · Propertymappings source ldap create #
Ask an LLM
“How do I map a custom LDAP attribute onto users synced from my directory?”
“Can I add an expression-based mapping to my LDAP sync?”
Tell an agent
Create an LDAP source mapping {name} with expression {expression}.
Add a new LDAP attribute mapping called {name}.
GET /propertymappings/source/ldap/{pm_uuid}/ Get an LDAP source property mapping · Propertymappings source ldap retrieve #
Ask an LLM
“Which directory attribute does a particular LDAP mapping read?”
“Can I view one LDAP source mapping in detail?”
Tell an agent
Show LDAP source mapping {mapping_id}.
Get the expression of LDAP mapping {mapping_id}.
PUT /propertymappings/source/ldap/{pm_uuid}/ Replace an LDAP source property mapping · Propertymappings source ldap update #
Ask an LLM
“Can I overwrite an LDAP mapping's name and expression in one request?”
“Is it possible to fully replace an LDAP source mapping definition?”
Tell an agent
Replace LDAP mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole LDAP source mapping {mapping_id}.
PATCH /propertymappings/source/ldap/{pm_uuid}/ Edit part of an LDAP source property mapping · Propertymappings source ldap partial update #
Ask an LLM
“Can I change only the expression on an LDAP mapping?”
“Is renaming an LDAP source mapping possible without touching its expression?”
Tell an agent
Update just the expression of LDAP mapping {mapping_id} to {expression}.
Rename LDAP source mapping {mapping_id} to {name} only.
DELETE /propertymappings/source/ldap/{pm_uuid}/ Delete an LDAP source property mapping · Propertymappings source ldap destroy #
Ask an LLM
“How do I stop syncing an LDAP attribute by deleting its mapping?”
“Can I remove an LDAP source mapping permanently?”
Tell an agent destructive · confirm first
Delete LDAP source mapping {mapping_id}.
Remove the LDAP attribute mapping {mapping_id}.
GET /propertymappings/source/ldap/{pm_uuid}/used_by/ See what uses an LDAP source mapping · Propertymappings source ldap used by list #
Ask an LLM
“Which LDAP sources use this property mapping?”
“Is an LDAP attribute mapping still in use by any directory sync?”
Tell an agent
List what references LDAP mapping {mapping_id}.
Check which LDAP sources depend on mapping {mapping_id}.
GET /propertymappings/source/oauth/ List OAuth source property mappings · Propertymappings source oauth list #
Ask an LLM
“Which mappings turn social login profile data into authentik user fields?”
“Can I filter OAuth source mappings by name?”
Tell an agent
List my OAuth source property mappings.
Find OAuth source mappings named {name}.
POST /propertymappings/source/oauth/ Create an OAuth source property mapping · Propertymappings source oauth create #
Ask an LLM
“How do I map extra profile fields from an OAuth login source onto users?”
“Can I write an expression for users who sign in through an OAuth source?”
Tell an agent
Create an OAuth source mapping {name} with expression {expression}.
Add a new social login attribute mapping called {name}.
GET /propertymappings/source/oauth/{pm_uuid}/ Get an OAuth source property mapping · Propertymappings source oauth retrieve #
Ask an LLM
“What does a particular OAuth source mapping set from the login profile?”
“Can I view one OAuth source mapping's expression?”
Tell an agent
Show OAuth source mapping {mapping_id}.
Get the expression of social login mapping {mapping_id}.
PUT /propertymappings/source/oauth/{pm_uuid}/ Replace an OAuth source property mapping · Propertymappings source oauth update #
Ask an LLM
“Can I fully overwrite an OAuth source mapping in one call?”
“Is resubmitting the whole OAuth source mapping the way to replace it?”
Tell an agent
Replace OAuth source mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole OAuth source mapping {mapping_id}.
PATCH /propertymappings/source/oauth/{pm_uuid}/ Edit part of an OAuth source property mapping · Propertymappings source oauth partial update #
Ask an LLM
“Can I change only the expression on an OAuth source mapping?”
“Is renaming an OAuth source mapping possible without resending its expression?”
Tell an agent
Update just the expression of OAuth source mapping {mapping_id} to {expression}.
Rename OAuth source mapping {mapping_id} to {name} only.
DELETE /propertymappings/source/oauth/{pm_uuid}/ Delete an OAuth source property mapping · Propertymappings source oauth destroy #
Ask an LLM
“How do I remove an OAuth source mapping?”
“Can I delete a social login attribute mapping I no longer need?”
Tell an agent destructive · confirm first
Delete OAuth source mapping {mapping_id}.
Remove the social login mapping {mapping_id}.
GET /propertymappings/source/oauth/{pm_uuid}/used_by/ See what uses an OAuth source mapping · Propertymappings source oauth used by list #
Ask an LLM
“Which OAuth login sources use this mapping?”
“Is a social login mapping still attached to any source?”
Tell an agent
List what references OAuth source mapping {mapping_id}.
Check which OAuth sources depend on mapping {mapping_id}.
GET /propertymappings/source/plex/ List Plex source property mappings · Propertymappings source plex list #
Ask an LLM
“Which mappings set user fields for people who sign in with Plex?”
“Can I list only my own Plex source mappings, excluding managed ones?”
Tell an agent
List my Plex source property mappings.
Find Plex source mappings named {name}.
POST /propertymappings/source/plex/ Create a Plex source property mapping · Propertymappings source plex create #
Ask an LLM
“What does it take to add a mapping for users coming from a Plex source?”
“Can I write a custom expression for Plex sign-ins?”
Tell an agent
Create a Plex source mapping {name} with expression {expression}.
Add a new Plex attribute mapping called {name}.
GET /propertymappings/source/plex/{pm_uuid}/ Get a Plex source property mapping · Propertymappings source plex retrieve #
Ask an LLM
“What does a particular Plex source mapping set on the user?”
“Can I view one Plex mapping's expression?”
Tell an agent
Show Plex source mapping {mapping_id}.
Get the expression of Plex mapping {mapping_id}.
PUT /propertymappings/source/plex/{pm_uuid}/ Replace a Plex source property mapping · Propertymappings source plex update #
Ask an LLM
“Can I fully overwrite a Plex source mapping?”
“Is there a way to replace a Plex mapping's name and expression together?”
Tell an agent
Replace Plex mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole Plex source mapping {mapping_id}.
PATCH /propertymappings/source/plex/{pm_uuid}/ Edit part of a Plex source property mapping · Propertymappings source plex partial update #
Ask an LLM
“Can I change only the expression on a Plex mapping?”
“Is renaming a Plex source mapping possible without resending the rest?”
Tell an agent
Update just the expression of Plex mapping {mapping_id} to {expression}.
Rename Plex source mapping {mapping_id} to {name} only.
DELETE /propertymappings/source/plex/{pm_uuid}/ Delete a Plex source property mapping · Propertymappings source plex destroy #
Ask an LLM
“How do I remove a Plex source mapping?”
“Can I delete a Plex attribute mapping for good?”
Tell an agent destructive · confirm first
Delete Plex source mapping {mapping_id}.
Remove the Plex attribute mapping {mapping_id}.
GET /propertymappings/source/plex/{pm_uuid}/used_by/ See what uses a Plex source mapping · Propertymappings source plex used by list #
Ask an LLM
“Which Plex sources use this mapping?”
“Is a Plex attribute mapping still referenced anywhere?”
Tell an agent
List what references Plex mapping {mapping_id}.
Check which Plex sources depend on mapping {mapping_id}.
GET /propertymappings/source/saml/ List SAML source property mappings · Propertymappings source saml list #
Ask an LLM
“Which mappings read attributes from an upstream identity provider's SAML assertions?”
“Can I filter SAML source mappings by name?”
Tell an agent
List my SAML source property mappings.
Find SAML source mappings named {name}.
POST /propertymappings/source/saml/ Create a SAML source property mapping · Propertymappings source saml create #
Ask an LLM
“How do I map an incoming SAML assertion attribute onto the user who logs in?”
“Can I add an expression for users federated in through a SAML source?”
Tell an agent
Create a SAML source mapping {name} with expression {expression}.
Add a new inbound SAML attribute mapping called {name}.
GET /propertymappings/source/saml/{pm_uuid}/ Get a SAML source property mapping · Propertymappings source saml retrieve #
Ask an LLM
“What does a particular SAML source mapping pull from incoming assertions?”
“Can I view one inbound SAML mapping's expression?”
Tell an agent
Show SAML source mapping {mapping_id}.
Get the expression of inbound SAML mapping {mapping_id}.
PUT /propertymappings/source/saml/{pm_uuid}/ Replace a SAML source property mapping · Propertymappings source saml update #
Ask an LLM
“Can I fully overwrite an inbound SAML source mapping?”
“Is it possible to replace a SAML source mapping's name and expression at once?”
Tell an agent
Replace SAML source mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole inbound SAML mapping {mapping_id}.
PATCH /propertymappings/source/saml/{pm_uuid}/ Edit part of a SAML source property mapping · Propertymappings source saml partial update #
Ask an LLM
“Can I change only the expression on an inbound SAML mapping?”
“Is renaming a SAML source mapping possible without resending its expression?”
Tell an agent
Update just the expression of SAML source mapping {mapping_id} to {expression}.
Rename inbound SAML mapping {mapping_id} to {name} only.
DELETE /propertymappings/source/saml/{pm_uuid}/ Delete a SAML source property mapping · Propertymappings source saml destroy #
Ask an LLM
“How do I remove a SAML source mapping?”
“Can I delete an inbound SAML attribute mapping?”
Tell an agent destructive · confirm first
Delete SAML source mapping {mapping_id}.
Remove the inbound SAML attribute mapping {mapping_id}.
GET /propertymappings/source/saml/{pm_uuid}/used_by/ See what uses a SAML source mapping · Propertymappings source saml used by list #
Ask an LLM
“Which SAML sources use this inbound mapping?”
“Is an inbound SAML mapping still attached to a federation source?”
Tell an agent
List what references SAML source mapping {mapping_id}.
Check which SAML sources depend on inbound mapping {mapping_id}.
GET /propertymappings/source/scim/ List SCIM source property mappings · Propertymappings source scim list #
Ask an LLM
“Which mappings handle users pushed into authentik by an external SCIM client?”
“Can I filter inbound SCIM source mappings by name?”
Tell an agent
List my SCIM source property mappings.
Find inbound SCIM source mappings named {name}.
POST /propertymappings/source/scim/ Create a SCIM source property mapping · Propertymappings source scim create #
Ask an LLM
“How do I map attributes from users provisioned into authentik over SCIM?”
“Can I add an expression for inbound SCIM users and groups?”
Tell an agent
Create a SCIM source mapping {name} with expression {expression}.
Add a new inbound SCIM attribute mapping called {name}.
GET /propertymappings/source/scim/{pm_uuid}/ Get a SCIM source property mapping · Propertymappings source scim retrieve #
Ask an LLM
“What does a particular inbound SCIM mapping set on provisioned users?”
“Can I view one SCIM source mapping's expression?”
Tell an agent
Show SCIM source mapping {mapping_id}.
Get the expression of inbound SCIM mapping {mapping_id}.
PUT /propertymappings/source/scim/{pm_uuid}/ Replace a SCIM source property mapping · Propertymappings source scim update #
Ask an LLM
“Can I fully overwrite an inbound SCIM source mapping?”
“Is it possible to replace a SCIM source mapping's name and expression together?”
Tell an agent
Replace SCIM source mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole inbound SCIM mapping {mapping_id}.
PATCH /propertymappings/source/scim/{pm_uuid}/ Edit part of a SCIM source property mapping · Propertymappings source scim partial update #
Ask an LLM
“Can I change only the expression on an inbound SCIM mapping?”
“Is renaming a SCIM source mapping possible without resending its code?”
Tell an agent
Update just the expression of SCIM source mapping {mapping_id} to {expression}.
Rename inbound SCIM mapping {mapping_id} to {name} only.
DELETE /propertymappings/source/scim/{pm_uuid}/ Delete a SCIM source property mapping · Propertymappings source scim destroy #
Ask an LLM
“How do I remove an inbound SCIM source mapping?”
“Can I delete a SCIM source attribute mapping?”
Tell an agent destructive · confirm first
Delete SCIM source mapping {mapping_id}.
Remove the inbound SCIM attribute mapping {mapping_id}.
GET /propertymappings/source/scim/{pm_uuid}/used_by/ See what uses a SCIM source mapping · Propertymappings source scim used by list #
Ask an LLM
“Which SCIM sources use this inbound mapping?”
“Is an inbound SCIM mapping still referenced before I remove it?”
Tell an agent
List what references SCIM source mapping {mapping_id}.
Check which SCIM sources depend on inbound mapping {mapping_id}.
GET /propertymappings/source/telegram/ List Telegram source property mappings · Propertymappings source telegram list #
Ask an LLM
“Which mappings set user fields for people who log in with Telegram?”
“Can I list only non-managed Telegram source mappings?”
Tell an agent
List my Telegram source property mappings.
Find Telegram source mappings named {name}.
POST /propertymappings/source/telegram/ Create a Telegram source property mapping · Propertymappings source telegram create #
Ask an LLM
“What's needed to add a mapping for users signing in through Telegram?”
“Can I write my own expression for Telegram login data?”
Tell an agent
Create a Telegram source mapping {name} with expression {expression}.
Add a new Telegram attribute mapping called {name}.
GET /propertymappings/source/telegram/{pm_uuid}/ Get a Telegram source property mapping · Propertymappings source telegram retrieve #
Ask an LLM
“What does a particular Telegram source mapping set on the user?”
“Can I view one Telegram mapping's expression?”
Tell an agent
Show Telegram source mapping {mapping_id}.
Get the expression of Telegram mapping {mapping_id}.
PUT /propertymappings/source/telegram/{pm_uuid}/ Replace a Telegram source property mapping · Propertymappings source telegram update #
Ask an LLM
“Can I fully overwrite a Telegram source mapping?”
“Can one request swap out a Telegram login mapping's name and its expression?”
Tell an agent
Replace Telegram mapping {mapping_id} with name {name} and expression {expression}.
Overwrite the whole Telegram source mapping {mapping_id}.
PATCH /propertymappings/source/telegram/{pm_uuid}/ Edit part of a Telegram source property mapping · Propertymappings source telegram partial update #
Ask an LLM
“Can I change only the expression on a Telegram mapping?”
“Is renaming a Telegram source mapping possible without resending the rest?”
Tell an agent
Update just the expression of Telegram mapping {mapping_id} to {expression}.
Rename Telegram source mapping {mapping_id} to {name} only.
DELETE /propertymappings/source/telegram/{pm_uuid}/ Delete a Telegram source property mapping · Propertymappings source telegram destroy #
Ask an LLM
“How do I remove a Telegram source mapping?”
“Can I delete a Telegram attribute mapping for good?”
Tell an agent destructive · confirm first
Delete Telegram source mapping {mapping_id}.
Remove the Telegram attribute mapping {mapping_id}.
GET /propertymappings/source/telegram/{pm_uuid}/used_by/ See what uses a Telegram source mapping · Propertymappings source telegram used by list #
Ask an LLM
“Which Telegram sources use this mapping?”
“Is a Telegram attribute mapping still referenced anywhere?”
Tell an agent
List what references Telegram mapping {mapping_id}.
Check which Telegram sources depend on mapping {mapping_id}.

Documentation

📖
Documentation
https://docs.goauthentik.io
📖
APIReference
https://api.goauthentik.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/openapi/authentik-propertymappings-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/goauthentik/authentik

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/overlays/authentik-propertymappings-api-overlay.yaml
🔗
SDKs
https://www.npmjs.com/package/@goauthentik/api
🔗
SDKs
https://pypi.org/project/authentik-client/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/authentik:authentik-propertymappings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

authentik-propertymappings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: authentik Propertymappings API
  version: 2026.11.0-rc1
  description: Making authentication simple.
  contact:
    email: hello@goauthentik.io
  license:
    name: MIT
    url: https://github.com/goauthentik/authentik/blob/main/LICENSE
  x-source-url: https://api.goauthentik.io/schema.yml
  x-last-validated: '2026-09-04'
servers:
- url: /api/v3
tags:


# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/openapi/authentik-propertymappings-api-openapi.yml