# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Oidc Provider API
  version: 1.0.0
extends: openapi/synadia-communications-oidc-provider-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: 6
- target: $.paths['/core/beta/oidc-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured OIDC sign-in providers
      effect: read
      questions:
      - Which OIDC identity providers are set up for single sign-on?
      - Where do I see all OIDC providers configured for login?
      instructions:
      - text: List the OIDC providers.
      - text: Show every configured OIDC sign-in provider.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/oidc-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an OIDC sign-in provider
      effect: write
      questions:
      - How do I set up single sign-on with an OIDC identity provider?
      - Can I map identity provider groups to roles when adding OIDC?
      - What fields does a Microsoft tenant need when configuring OIDC?
      instructions:
      - text: Add an OIDC provider for domain {domain}, enabled={enabled}, with client ID {client_id} and issuer {issuer}.
        slots:
          domain: requestBody.domain
          enabled: requestBody.enabled
          client_id: requestBody.client_id
          issuer: requestBody.issuer_url
      - text: Configure OIDC login for domain {domain} with Microsoft tenant {tenant}, enabled={enabled}.
        slots:
          domain: requestBody.domain
          enabled: requestBody.enabled
          tenant: requestBody.microsoft_tenant
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/oidc-providers/{oidcProviderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one OIDC provider
      effect: read
      questions:
      - How can I view the settings of a specific OIDC provider?
      - What issuer and client ID is a given OIDC provider using?
      instructions:
      - text: Show OIDC provider {provider}.
        slots:
          provider: path.oidcProviderId
      - text: Get the configuration of OIDC provider {provider}.
        slots:
          provider: path.oidcProviderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/oidc-providers/{oidcProviderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an OIDC provider
      effect: destructive
      questions:
      - Can I remove an OIDC provider so it's no longer used for login?
      - How do I delete an SSO identity provider configuration?
      instructions:
      - text: Delete OIDC provider {provider}.
        slots:
          provider: path.oidcProviderId
      - text: Remove the OIDC sign-in provider {provider}.
        slots:
          provider: path.oidcProviderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/oidc-providers/{oidcProviderId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an OIDC provider's settings
      effect: write
      questions:
      - How do I rotate the client secret on an existing OIDC provider?
      - Can I disable an OIDC provider temporarily without deleting it?
      instructions:
      - text: Update OIDC provider {provider} with client secret {secret}.
        slots:
          provider: path.oidcProviderId
          secret: requestBody.client_secret
      - text: Set enabled to {enabled} on OIDC provider {provider}.
        slots:
          provider: path.oidcProviderId
          enabled: requestBody.enabled
      - text: Change the group-to-role mappings on OIDC provider {provider} to {mappings}.
        slots:
          provider: path.oidcProviderId
          mappings: requestBody.group_role_mappings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/oidc-providers/defaults'].get
  update:
    x-apievangelist-phrasing:
      intent: List default OIDC provider templates
      effect: read
      questions:
      - What default settings are offered for common OIDC identity providers?
      - Are there preset OIDC provider defaults I can start from?
      instructions:
      - text: List the OIDC provider defaults.
      - text: Show the preset OIDC provider templates.
      method: generated
      generated: '2026-10-01'