API Evangelist conversational phrasing for authentik Propertymappings API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Propertymappings API
  version: 1.0.0
extends: openapi/authentik-propertymappings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 111
- target: $.paths['/propertymappings/all/'].get
  update:
    x-apievangelist-phrasing:
      intent: List property mappings of every type
      effect: read
      questions:
      - What property mappings exist across all types in my authentik instance?
      - Can I see only the built-in managed mappings, whatever kind they are?
      instructions:
      - text: List every property mapping regardless of type.
      - text: Search all property mappings of any type for {term}.
        slots:
          term: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/all/{pm_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get any property mapping by ID
      effect: read
      questions:
      - 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?
      instructions:
      - text: Show the generic property mapping record for {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Look up mapping {mapping_id} without knowing which kind it is.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/all/{pm_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete any property mapping by ID
      effect: destructive
      questions:
      - 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?
      instructions:
      - text: Delete property mapping {mapping_id} via the all-types endpoint.
        slots:
          mapping_id: path.pm_uuid
      - text: Remove mapping {mapping_id}, whatever type it is.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/all/{pm_uuid}/test/'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a property mapping against a user
      effect: read
      questions:
      - 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?
      - Is there a way to get the mapping test output pretty-formatted?
      instructions:
      - text: Test property mapping {mapping_id} against user {user}.
        slots:
          mapping_id: path.pm_uuid
          user: requestBody.user
      - text: Evaluate mapping {mapping_id} for group {group} and format the result.
        slots:
          mapping_id: path.pm_uuid
          group: requestBody.group
      - text: Run mapping {mapping_id} with extra context {context} and show what it outputs.
        slots:
          mapping_id: path.pm_uuid
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/all/{pm_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses any property mapping
      effect: read
      questions:
      - 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?
      instructions:
      - text: Show every object that depends on mapping {mapping_id} using the all-types lookup.
        slots:
          mapping_id: path.pm_uuid
      - text: Check what still references generic mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/all/types/'].get
  update:
    x-apievangelist-phrasing:
      intent: List creatable property mapping types
      effect: read
      questions:
      - What kinds of property mappings can I create in authentik?
      - Which mapping types are available to choose from when adding a new one?
      instructions:
      - text: List all the property mapping types I can create.
      - text: Show the available mapping kinds with their component names.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/notification/'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification webhook mappings
      effect: read
      questions:
      - Which webhook mappings shape the payload of my notification transports?
      - Can I filter notification webhook mappings by name?
      instructions:
      - text: List my notification webhook mappings.
      - text: Find the notification webhook mapping called {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/notification/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification webhook mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a notification webhook mapping {name} with expression {expression}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
      - text: Add a new webhook payload mapping named {name} that returns {expression}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/notification/{pm_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification webhook mapping
      effect: read
      questions:
      - What expression does a particular notification webhook mapping run?
      - Can I view the details of one webhook payload mapping?
      instructions:
      - text: Show notification webhook mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Get the expression of webhook mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/notification/{pm_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a notification webhook mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Replace webhook mapping {mapping_id} with name {name} and expression {expression}.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
          expression: requestBody.expression
      - text: Overwrite notification mapping {mapping_id} entirely, naming it {name}.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/notification/{pm_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification webhook mapping
      effect: destructive
      questions:
      - How do I remove a webhook payload mapping I no longer use?
      - Can I delete a notification webhook mapping for good?
      instructions:
      - text: Delete notification webhook mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Remove the webhook payload mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/notification/{pm_uuid}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a notification webhook mapping
      effect: write
      questions:
      - Can I change only the expression of a notification webhook mapping?
      - Is it possible to rename a webhook mapping without resending its expression?
      instructions:
      - text: Change just the expression of webhook mapping {mapping_id} to {expression}.
        slots:
          mapping_id: path.pm_uuid
          expression: requestBody.expression
      - text: Rename notification webhook mapping {mapping_id} to {name}, leaving the rest.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/notification/{pm_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a notification webhook mapping
      effect: read
      questions:
      - Which notification transports rely on this webhook mapping?
      - Is a given webhook payload mapping still in use anywhere?
      instructions:
      - text: List the objects that use notification webhook mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Check whether webhook mapping {mapping_id} is referenced by any transport.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/google_workspace/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Google Workspace provider mappings
      effect: read
      questions:
      - Which mappings control how users sync out to Google Workspace?
      - Can I filter Google Workspace provisioning mappings by expression or managed status?
      instructions:
      - text: List my Google Workspace provider mappings.
      - text: Find Google Workspace provisioning mappings named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/google_workspace/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Google Workspace provider mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a Google Workspace provider mapping {name} with expression {expression}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
      - text: Add a new Google Workspace provisioning mapping called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/google_workspace/{pm_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Google Workspace provider mapping
      effect: read
      questions:
      - What does a specific Google Workspace provisioning mapping send?
      - Is this Google Workspace mapping one of the built-in managed ones?
      instructions:
      - text: Show Google Workspace provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Get the expression behind Google Workspace mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/google_workspace/{pm_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Google Workspace provider mapping
      effect: write
      questions:
      - How do I fully overwrite a Google Workspace provisioning mapping?
      - Can I resubmit the whole definition of a Google Workspace mapping in one go?
      instructions:
      - text: Replace Google Workspace mapping {mapping_id} with name {name} and expression {expression}.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
          expression: requestBody.expression
      - text: Overwrite the full Google Workspace provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/google_workspace/{pm_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Google Workspace provider mapping
      effect: destructive
      questions:
      - How do I get rid of a Google Workspace provisioning mapping?
      - Can I delete a custom mapping from my Google Workspace sync?
      instructions:
      - text: Delete Google Workspace provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Remove the Google Workspace sync mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/google_workspace/{pm_uuid}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a Google Workspace provider mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update just the expression of Google Workspace mapping {mapping_id} to {expression}.
        slots:
          mapping_id: path.pm_uuid
          expression: requestBody.expression
      - text: Rename Google Workspace mapping {mapping_id} to {name} only.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/google_workspace/{pm_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a Google Workspace provider mapping
      effect: read
      questions:
      - Which Google Workspace providers use this mapping?
      - Is a given Google Workspace mapping safe to delete?
      instructions:
      - text: List what references Google Workspace mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Check which providers depend on Google Workspace mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/microsoft_entra/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Microsoft Entra provider mappings
      effect: read
      questions:
      - Which mappings control how users are provisioned into Microsoft Entra ID?
      - Can I search my Entra provisioning mappings by expression text?
      instructions:
      - text: List my Microsoft Entra provider mappings.
      - text: Find Entra provisioning mappings matching {term}.
        slots:
          term: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/microsoft_entra/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Microsoft Entra provider mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a Microsoft Entra provider mapping {name} with expression {expression}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
      - text: Add a new Entra ID sync mapping called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/microsoft_entra/{pm_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Microsoft Entra provider mapping
      effect: read
      questions:
      - What does a particular Microsoft Entra provisioning mapping send?
      - Can I read the expression of one Entra ID mapping?
      instructions:
      - text: Show Microsoft Entra provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Get the details of Entra mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/microsoft_entra/{pm_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Microsoft Entra provider mapping
      effect: write
      questions:
      - How do I fully overwrite a Microsoft Entra provisioning mapping?
      - Can I resend the entire Entra mapping definition to replace it?
      instructions:
      - text: Replace Entra mapping {mapping_id} with name {name} and expression {expression}.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
          expression: requestBody.expression
      - text: Overwrite the whole Microsoft Entra provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/microsoft_entra/{pm_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Microsoft Entra provider mapping
      effect: destructive
      questions:
      - How do I remove a Microsoft Entra provisioning mapping?
      - Can I delete a custom mapping from my Entra ID sync?
      instructions:
      - text: Delete Microsoft Entra provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Remove the Entra ID sync mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/microsoft_entra/{pm_uuid}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a Microsoft Entra provider mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update just the expression of Entra mapping {mapping_id} to {expression}.
        slots:
          mapping_id: path.pm_uuid
          expression: requestBody.expression
      - text: Rename Microsoft Entra mapping {mapping_id} to {name} only.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/microsoft_entra/{pm_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a Microsoft Entra provider mapping
      effect: read
      questions:
      - Which Microsoft Entra providers use this mapping?
      - Is a given Entra mapping still referenced before I delete it?
      instructions:
      - text: List what references Entra mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Check which providers depend on Microsoft Entra mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/rac/'].get
  update:
    x-apievangelist-phrasing:
      intent: List RAC remote access property mappings
      effect: read
      questions:
      - Which property mappings configure my remote access (RAC) connections?
      - Can I list only the managed RAC mappings?
      instructions:
      - text: List my RAC property mappings.
      - text: Find RAC remote access mappings named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/rac/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a RAC remote access property mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a RAC property mapping {name} with static settings {static_settings}.
        slots:
          name: requestBody.name
          static_settings: requestBody.static_settings
      - text: Add RAC mapping {name} using settings {static_settings} and expression {expression}.
        slots:
          name: requestBody.name
          static_settings: requestBody.static_settings
          expression: requestBody.expression
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/rac/{pm_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a RAC remote access property mapping
      effect: read
      questions:
      - What static settings does a particular RAC mapping apply to connections?
      - Can I view a single remote access property mapping?
      instructions:
      - text: Show RAC property mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Get the static settings of RAC mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/rac/{pm_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a RAC remote access property mapping
      effect: write
      questions:
      - 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?
      instructions:
      - text: Replace RAC mapping {mapping_id} with name {name} and static settings {static_settings}.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
          static_settings: requestBody.static_settings
      - text: Overwrite the whole RAC property mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/rac/{pm_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a RAC remote access property mapping
      effect: destructive
      questions:
      - How do I remove a remote access property mapping?
      - Can I delete a RAC mapping I no longer need?
      instructions:
      - text: Delete RAC property mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Remove the remote access mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/rac/{pm_uuid}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a RAC remote access property mapping
      effect: write
      questions:
      - Can I change just the static settings on a RAC mapping?
      - Is it possible to update only the expression of a remote access mapping?
      instructions:
      - text: Update only the static settings of RAC mapping {mapping_id} to {static_settings}.
        slots:
          mapping_id: path.pm_uuid
          static_settings: requestBody.static_settings
      - text: Change just the expression on RAC mapping {mapping_id} to {expression}.
        slots:
          mapping_id: path.pm_uuid
          expression: requestBody.expression
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/rac/{pm_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a RAC remote access mapping
      effect: read
      questions:
      - Which RAC providers or endpoints use this property mapping?
      - Is a remote access mapping still attached to anything?
      instructions:
      - text: List what references RAC mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Check which endpoints depend on remote access mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/radius/'].get
  update:
    x-apievangelist-phrasing:
      intent: List RADIUS provider property mappings
      effect: read
      questions:
      - Which property mappings add attributes to my RADIUS responses?
      - Can I filter RADIUS mappings to the non-managed ones I wrote myself?
      instructions:
      - text: List my RADIUS provider property mappings.
      - text: Find RADIUS mappings named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/radius/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a RADIUS provider property mapping
      effect: write
      questions:
      - How do I return custom RADIUS attributes with an expression?
      - Can I add a new property mapping for my RADIUS provider?
      instructions:
      - text: Create a RADIUS property mapping {name} with expression {expression}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
      - text: Add a new RADIUS attribute mapping called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/radius/{pm_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a RADIUS provider property mapping
      effect: read
      questions:
      - What expression does a particular RADIUS mapping evaluate?
      - Can I view one RADIUS provider property mapping?
      instructions:
      - text: Show RADIUS property mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Get the expression of RADIUS mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/radius/{pm_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a RADIUS provider property mapping
      effect: write
      questions:
      - How do I fully overwrite a RADIUS property mapping?
      - Can I replace the whole definition of a RADIUS attribute mapping?
      instructions:
      - text: Replace RADIUS mapping {mapping_id} with name {name} and expression {expression}.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
          expression: requestBody.expression
      - text: Overwrite the whole RADIUS property mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/radius/{pm_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a RADIUS provider property mapping
      effect: destructive
      questions:
      - How do I remove a RADIUS attribute mapping?
      - Can I delete a RADIUS property mapping for good?
      instructions:
      - text: Delete RADIUS property mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Remove the RADIUS attribute mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/radius/{pm_uuid}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a RADIUS provider property mapping
      effect: write
      questions:
      - Can I change only the expression of a RADIUS mapping?
      - Is it possible to rename a RADIUS property mapping without resending the rest?
      instructions:
      - text: Update just the expression of RADIUS mapping {mapping_id} to {expression}.
        slots:
          mapping_id: path.pm_uuid
          expression: requestBody.expression
      - text: Rename RADIUS mapping {mapping_id} to {name} only.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/radius/{pm_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a RADIUS provider mapping
      effect: read
      questions:
      - Which RADIUS providers use this property mapping?
      - Is a RADIUS attribute mapping still referenced before I remove it?
      instructions:
      - text: List what references RADIUS mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Check which providers depend on RADIUS mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/saml/'].get
  update:
    x-apievangelist-phrasing:
      intent: List SAML provider property mappings
      effect: read
      questions:
      - Which attribute mappings go into the SAML assertions my apps receive?
      - Can I filter SAML provider mappings by SAML attribute name or friendly name?
      instructions:
      - text: List my SAML provider property mappings.
      - text: Find SAML provider mappings that emit attribute {saml_name}.
        slots:
          saml_name: query.saml_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/saml/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SAML provider property mapping
      effect: write
      questions:
      - How do I add a custom attribute to outgoing SAML assertions?
      - Can I give a new SAML assertion attribute a friendly name too?
      instructions:
      - text: Create a SAML provider mapping {name} that sets attribute {saml_name} to {expression}.
        slots:
          name: requestBody.name
          saml_name: requestBody.saml_name
          expression: requestBody.expression
      - text: Add assertion mapping {name} for SAML attribute {saml_name} with friendly name {friendly_name}.
        slots:
          name: requestBody.name
          saml_name: requestBody.saml_name
          friendly_name: requestBody.friendly_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/saml/{pm_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SAML provider property mapping
      effect: read
      questions:
      - Which SAML attribute name does a particular assertion mapping produce?
      - Can I view one SAML provider mapping's expression?
      instructions:
      - text: Show SAML provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Get the assertion attribute and expression of SAML provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/saml/{pm_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SAML provider property mapping
      effect: write
      questions:
      - How do I overwrite an assertion mapping's name, SAML attribute and expression together?
      - Can I fully replace a SAML provider mapping definition?
      instructions:
      - text: Replace SAML provider mapping {mapping_id} with name {name}, attribute {saml_name} and expression {expression}.
        slots:
          mapping_id: path.pm_uuid
          name: requestBody.name
          saml_name: requestBody.saml_name
          expression: requestBody.expression
      - text: Overwrite the whole SAML assertion mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/propertymappings/provider/saml/{pm_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SAML provider property mapping
      effect: destructive
      questions:
      - How do I stop sending an attribute in SAML assertions by deleting its mapping?
      - Can I remove a SAML provider mapping entirely?
      instructions:
      - text: Delete SAML provider mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      - text: Remove the SAML assertion attribute mapping {mapping_id}.
        slots:
          mapping_id: path.pm_uuid
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/overlays/authentik-propertymappings-api-phrasing-overlay.yaml