API Evangelist conversational phrasing for Auth0 Management Connections API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Connections API
  version: 1.0.0
extends: openapi/auth0-connections-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 28
- target: $.paths['/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity connections in the tenant
      effect: read
      questions:
      - Which identity provider connections are set up in my Auth0 tenant?
      - Can I list only the connections that use a particular strategy, like SAML or Google?
      - How do I find a connection by its name?
      instructions:
      - text: List all connections in my tenant.
      - text: List the connections using the {strategy} strategy.
        slots:
          strategy: query.strategy
      - text: Find the connection named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an identity connection
      effect: write
      questions:
      - How do I add a new database or social login connection?
      - Can I enable a new connection for specific applications when I create it?
      instructions:
      - text: Create a connection named {name} using the {strategy} strategy.
        slots:
          name: requestBody.name
          strategy: requestBody.strategy
      - text: Create connection {name} with strategy {strategy} enabled for clients {enabled_clients}.
        slots:
          name: requestBody.name
          strategy: requestBody.strategy
          enabled_clients: requestBody.enabled_clients
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection's configuration
      effect: read
      questions:
      - What options and identity provider settings does a specific connection have?
      - Can I see a single connection's full configuration by its ID?
      instructions:
      - text: Get connection {id}.
        slots:
          id: path.id
      - text: Show the options of connection {id}, including only fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connection
      effect: destructive
      questions:
      - What happens to users when I delete a connection?
      - Is deleting a connection reversible?
      instructions:
      - text: Delete connection {id}.
        slots:
          id: path.id
      - text: Permanently remove connection {id} so nobody can log in through it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a connection's settings
      effect: write
      questions:
      - Does updating a connection's options replace the whole options object?
      - How do I change the display name of an existing connection?
      instructions:
      - text: Change the display name of connection {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Replace the options of connection {id} with {options}.
        slots:
          id: path.id
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications that use a connection
      effect: read
      questions:
      - Which applications have a given connection enabled?
      - How does paging work when listing the clients enabled on a connection?
      instructions:
      - text: List the clients that have connection {id} enabled.
        slots:
          id: path.id
      - text: Show the next {take} applications using connection {id}.
        slots:
          take: query.take
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/clients'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change which applications use a connection
      effect: write
      questions:
      - Can I enable or disable a connection for several applications at once?
      - What's the way to update a connection's list of enabled clients?
      instructions:
      - text: Update the enabled clients for connection {id}.
        slots:
          id: path.id
      - text: Change which applications can use connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection's directory provisioning setup
      effect: read
      questions:
      - How is directory provisioning configured for one connection?
      - Is automatic directory synchronization turned on for this connection?
      instructions:
      - text: Get the directory provisioning configuration of connection {id}.
        slots:
          id: path.id
      - text: Show whether connection {id} synchronizes its directory automatically.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up directory provisioning for a connection
      effect: write
      questions:
      - How do I turn on directory provisioning for an enterprise connection?
      - Can I sync groups as well as users when I set up directory provisioning?
      instructions:
      - text: Create a directory provisioning configuration for connection {id}.
        slots:
          id: path.id
      - text: Set up directory provisioning on connection {id} with group sync {synchronize_groups}.
        slots:
          id: path.id
          synchronize_groups: requestBody.synchronize_groups
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove directory provisioning from a connection
      effect: destructive
      questions:
      - How do I turn off directory provisioning for a connection entirely?
      - Can I delete a connection's directory provisioning setup without deleting the connection?
      instructions:
      - text: Delete the directory provisioning configuration of connection {id}.
        slots:
          id: path.id
      - text: Stop directory provisioning on connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a connection's directory provisioning
      effect: write
      questions:
      - How do I change the attribute mapping used by directory provisioning?
      - Can I switch off automatic synchronization but keep provisioning configured?
      instructions:
      - text: Update the directory provisioning mapping of connection {id} to {mapping}.
        slots:
          id: path.id
          mapping: requestBody.mapping
      - text: Set automatic directory sync on connection {id} to {synchronize_automatically}.
        slots:
          id: path.id
          synchronize_automatically: requestBody.synchronize_automatically
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning/default-mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default directory provisioning attribute mapping
      effect: read
      questions:
      - What attribute mapping does directory provisioning use by default for a connection?
      - Where can I see the out-of-the-box directory sync attribute map?
      instructions:
      - text: Get the default directory provisioning mapping for connection {id}.
        slots:
          id: path.id
      - text: Show the default directory sync attributes for connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning/synchronizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an on-demand directory sync
      effect: write
      questions:
      - Can I force a directory sync right now instead of waiting for the schedule?
      - How do I request an immediate directory synchronization for a connection?
      instructions:
      - text: Run a directory synchronization now for connection {id}.
        slots:
          id: path.id
      - text: Request an on-demand directory sync on connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning/synchronized-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups selected for directory sync
      effect: read
      questions:
      - Which directory groups are selected for synchronization on a connection?
      - Can I page through the synchronized groups of a provisioning setup?
      instructions:
      - text: List the synchronized groups for connection {id}.
        slots:
          id: path.id
      - text: Show the next {take} groups selected for sync on connection {id}.
        slots:
          take: query.take
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/directory-provisioning/synchronized-groups'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the groups selected for directory sync
      effect: write
      questions:
      - How do I choose which directory groups get synchronized?
      - Does setting synchronized groups replace the previous selection?
      instructions:
      - text: Set the synchronized groups for connection {id} to {groups}.
        slots:
          id: path.id
          groups: requestBody.groups
      - text: Replace the directory sync group selection on connection {id} with {groups}.
        slots:
          id: path.id
          groups: requestBody.groups
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: Get signing keys for an Okta or OIDC connection
      effect: read
      questions:
      - What keys does an Okta or OIDC connection currently use?
      - Can I view the Private Key JWT keys of an OIDC connection?
      instructions:
      - text: Get the connection keys for connection {id}.
        slots:
          id: path.id
      - text: Show the current signing keys of OIDC connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision initial keys for an OIDC connection
      effect: write
      questions:
      - How do I create keys before switching an OIDC connection to Private Key JWT?
      - Can I choose the signing algorithm for initial connection keys?
      instructions:
      - text: Create initial connection keys for connection {id}.
        slots:
          id: path.id
      - text: Provision keys for connection {id} using signing algorithm {signing_alg}.
        slots:
          id: path.id
          signing_alg: requestBody.signing_alg
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/keys/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an Okta or OIDC connection's keys
      effect: write
      questions:
      - How do I rotate the keys on an Okta connection?
      - Can I change the signing algorithm while rotating connection keys?
      instructions:
      - text: Rotate the keys for connection {id}.
        slots:
          id: path.id
      - text: Rotate connection {id}'s keys to signing algorithm {signing_alg}.
        slots:
          id: path.id
          signing_alg: requestBody.signing_alg
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection's SCIM configuration
      effect: read
      questions:
      - How is SCIM inbound provisioning configured for a connection?
      - Which user attribute does a connection's SCIM setup use as the user ID?
      instructions:
      - text: Get the SCIM configuration for connection {id}.
        slots:
          id: path.id
      - text: Show the SCIM mapping currently set on connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable SCIM provisioning on a connection
      effect: write
      questions:
      - How do I enable SCIM provisioning for an enterprise connection?
      - Can I supply a custom attribute mapping when creating a SCIM configuration?
      instructions:
      - text: Create a SCIM configuration for connection {id}.
        slots:
          id: path.id
      - text: Set up SCIM on connection {id} using {user_id_attribute} as the user ID attribute.
        slots:
          id: path.id
          user_id_attribute: requestBody.user_id_attribute
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a connection's SCIM configuration
      effect: destructive
      questions:
      - How do I turn off SCIM provisioning for a connection?
      - Can I delete just the SCIM setup and keep the connection?
      instructions:
      - text: Delete the SCIM configuration of connection {id}.
        slots:
          id: path.id
      - text: Disable SCIM provisioning on connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a connection's SCIM mapping
      effect: write
      questions:
      - How do I change the SCIM attribute mapping on a connection?
      - Must I send both the user ID attribute and the mapping when updating SCIM?
      instructions:
      - text: Update connection {id}'s SCIM config to user ID attribute {user_id_attribute} and mapping {mapping}.
        slots:
          id: path.id
          user_id_attribute: requestBody.user_id_attribute
          mapping: requestBody.mapping
      - text: Change the SCIM mapping on connection {id} to {mapping}, keeping {user_id_attribute} as the ID.
        slots:
          id: path.id
          mapping: requestBody.mapping
          user_id_attribute: requestBody.user_id_attribute
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration/default-mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default SCIM attribute mapping
      effect: read
      questions:
      - What is the default SCIM attribute mapping for a connection?
      - Can I see the SCIM mapping a connection would use before I customize it?
      instructions:
      - text: Get the default SCIM mapping for connection {id}.
        slots:
          id: path.id
      - text: Show connection {id}'s out-of-the-box SCIM attribute map.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List a connection's SCIM tokens
      effect: read
      questions:
      - Which SCIM tokens have been issued for a connection?
      - When do the SCIM bearer tokens on a connection expire?
      instructions:
      - text: List the SCIM tokens for connection {id}.
        slots:
          id: path.id
      - text: Show all SCIM client tokens issued on connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SCIM token for a connection
      effect: write
      questions:
      - How do I generate a bearer token for my SCIM client?
      - Can I set a lifetime and scopes on a new SCIM token?
      instructions:
      - text: Create a SCIM token for connection {id}.
        slots:
          id: path.id
      - text: Issue a SCIM token on connection {id} with scopes {scopes} lasting {token_lifetime} seconds.
        slots:
          id: path.id
          scopes: requestBody.scopes
          token_lifetime: requestBody.token_lifetime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/scim-configuration/tokens/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a connection's SCIM token
      effect: destructive
      questions:
      - How do I revoke a leaked SCIM token?
      - Can I delete one SCIM token without affecting others on the connection?
      instructions:
      - text: Delete SCIM token {tokenId} from connection {id}.
        slots:
          tokenId: path.tokenId
          id: path.id
      - text: Revoke the SCIM token {tokenId} on connection {id}.
        slots:
          tokenId: path.tokenId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an AD/LDAP connection is online
      effect: read
      questions:
      - Is my AD/LDAP connector online right now?
      - What does a 404 from the connection status check mean?
      instructions:
      - text: Check the status of connection {id}.
        slots:
          id: path.id
      - text: Tell me whether LDAP connection {id} is online.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{id}/users'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database connection user by email
      effect: destructive
      questions:
      - How do I delete a user from a database connection by their email address?
      - Can I wipe all users from a connection at once?
      instructions:
      - text: Delete the user {email} from connection {id}.
        slots:
          email: query.email
          id: path.id
      - text: Remove {email} from database connection {id}.
        slots:
          email: query.email
          id: path.id
      method: generated
      generated: '2026-10-01'