# 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 SAML Connections API
  version: 1.0.0
extends: openapi/clerk-com-saml-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['/saml_connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List SAML connections
      effect: read
      questions:
      - What SAML SSO connections are configured in my instance?
      - Can I list the SAML connections for one organization?
      instructions:
      - text: List all SAML connections.
      - text: Show the SAML connections of organization {organization_id}.
        slots:
          organization_id: query.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml_connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SAML SSO connection
      effect: write
      questions:
      - How do I set up SAML single sign-on for a customer's identity provider?
      - Can I configure a SAML connection from the IdP metadata URL?
      - Is the SAML connections endpoint deprecated?
      instructions:
      - text: Create a SAML connection {name} for provider {provider} on domain {domain}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
          domain: requestBody.domain
      - text: Set up SAML SSO {name} with provider {provider} using metadata URL {idp_metadata_url}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
          idp_metadata_url: requestBody.idp_metadata_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml_connections/{saml_connection_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a SAML connection
      effect: read
      questions:
      - How do I view the IdP settings of one SAML connection?
      - What configuration is stored on a single SAML connection?
      instructions:
      - text: Get SAML connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      - text: Show the identity provider settings of SAML connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml_connections/{saml_connection_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SAML connection
      effect: destructive
      questions:
      - How do I remove a SAML SSO connection for a customer who left?
      - Can I delete a SAML connection by its ID?
      instructions:
      - text: Delete SAML connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      - text: Remove the SSO connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml_connections/{saml_connection_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a SAML connection
      effect: write
      questions:
      - How do I rotate the IdP certificate on an existing SAML connection?
      - Can I deactivate a SAML connection without deleting it?
      - Is it possible to allow IdP-initiated sign-in on a SAML connection?
      instructions:
      - text: Replace the IdP certificate of SAML connection {saml_connection_id} with {idp_certificate}.
        slots:
          saml_connection_id: path.saml_connection_id
          idp_certificate: requestBody.idp_certificate
      - text: Set SAML connection {saml_connection_id} active to {active}.
        slots:
          saml_connection_id: path.saml_connection_id
          active: requestBody.active
      method: generated
      generated: '2026-09-26'