# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Backend Enterprise Connections API
  version: 1.0.0
extends: openapi/clerk-com-enterprise-connections-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: 5
- target: $.paths['/enterprise_connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List enterprise SSO connections
      effect: read
      questions:
      - Which enterprise SSO connections are set up on my instance?
      - Can I list only the active enterprise connections for one organization?
      instructions:
      - text: List my enterprise connections.
      - text: Show enterprise connections tied to organization {organization_id}.
        slots:
          organization_id: query.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise_connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an enterprise SSO connection
      effect: write
      questions:
      - How do I set up SAML or OIDC single sign-on for a customer's email domains?
      - Can a new enterprise connection be linked to an organization?
      instructions:
      - text: Create an enterprise connection {name} with provider {provider} for domains {domains}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
          domains: requestBody.domains
      - text: Set up SSO {name} via {provider} on {domains} for organization {organization_id}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
          domains: requestBody.domains
          organization_id: requestBody.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise_connections/{enterprise_connection_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an enterprise connection
      effect: read
      questions:
      - What SAML or OIDC settings does a specific enterprise connection have?
      - Is a given enterprise connection currently active?
      instructions:
      - text: Get enterprise connection {enterprise_connection_id}.
        slots:
          enterprise_connection_id: path.enterprise_connection_id
      - text: Show the SSO configuration of {enterprise_connection_id}.
        slots:
          enterprise_connection_id: path.enterprise_connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise_connections/{enterprise_connection_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an enterprise connection
      effect: destructive
      questions:
      - How do I remove an enterprise SSO connection I no longer need?
      - Can I permanently delete a SAML or OIDC connection?
      instructions:
      - text: Delete enterprise connection {enterprise_connection_id}.
        slots:
          enterprise_connection_id: path.enterprise_connection_id
      - text: Remove SSO connection {enterprise_connection_id} permanently.
        slots:
          enterprise_connection_id: path.enterprise_connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise_connections/{enterprise_connection_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or activate an enterprise connection
      effect: write
      questions:
      - How do I turn on an enterprise connection once its SSO is configured?
      - Can I change the domains covered by an existing enterprise connection?
      instructions:
      - text: Activate enterprise connection {enterprise_connection_id}.
        slots:
          enterprise_connection_id: path.enterprise_connection_id
      - text: Change the domains of enterprise connection {enterprise_connection_id} to {domains}.
        slots:
          enterprise_connection_id: path.enterprise_connection_id
          domains: requestBody.domains
      method: generated
      generated: '2026-09-26'