Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend SAML API

3 actions 3 updates phrasing extends openapi/clerk-com-saml-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/saml/metadata/{saml_connection_id}.xml'].get
$.paths['/v1/saml/acs/{saml_connection_id}'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Frontend SAML API
  version: 1.0.0
extends: openapi/clerk-com-saml-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: 2
- target: $.paths['/v1/saml/metadata/{saml_connection_id}.xml'].get
  update:
    x-apievangelist-phrasing:
      intent: Get service provider SAML metadata
      effect: read
      questions:
      - Where do I get the SAML service provider metadata XML to give my IdP?
      - What entity ID and ACS URL does my SAML connection expose?
      instructions:
      - text: Get the SAML metadata XML for connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      - text: Download the service provider metadata of SAML connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/saml/acs/{saml_connection_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive a SAML response from the IdP
      effect: write
      questions:
      - Which endpoint processes the SAML responses my identity provider posts back?
      - What is the Assertion Consumer Service URL used for?
      instructions:
      - text: Process the IdP's SAML response for connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      - text: Consume the SAML assertion posted to connection {saml_connection_id}.
        slots:
          saml_connection_id: path.saml_connection_id
      method: generated
      generated: '2026-09-26'