API Evangelist conversational phrasing for User Management Organization External Integration API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for User Management Organization External Integration API
  version: 1.0.0
extends: openapi/conga-organization-external-integration-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: 10
- target: $.paths['/api/user-management/v1/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List external integration identifiers
      effect: read
      questions:
      - Which external integrations are linked to our org?
      - Can I page through external integration identifiers?
      instructions:
      - text: List external integration identifiers.
      - text: Show {size} integration identifiers per page.
        slots:
          size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations'].put
  update:
    x-apievangelist-phrasing:
      intent: Update external identifiers
      effect: write
      questions:
      - How do I update several external identifiers at once?
      - Can I replace the integration identifiers for my org?
      instructions:
      - text: Update the external identifiers to {ids}.
        slots:
          ids: requestBody.ExternalIntegrationIdentifiers
      - text: Replace org integration identifiers with {ids}.
        slots:
          ids: requestBody.ExternalIntegrationIdentifiers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an external identity integration
      effect: write
      questions:
      - How do I connect a SAML identity provider?
      - Can I map an email domain to an external IdP?
      instructions:
      - text: Add external integration {ext} with provider {provider}.
        slots:
          ext: query.ExternalId
          provider: query.Provider
      - text: Connect SAML metadata at {url} for domain {domain}.
        slots:
          url: query.SAMLMetadataLocationURL
          domain: query.EmailDomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete external identifiers
      effect: destructive
      questions:
      - Can I remove all external identifiers from the org?
      - How do I delete integration identifiers in bulk?
      instructions:
      - text: Delete the external identifiers.
      - text: Remove org integration identifiers in bulk.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations/identity-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity providers
      effect: read
      questions:
      - Which identity providers can we sign in with?
      - What IdPs are configured?
      instructions:
      - text: List all identity providers.
      - text: Show configured IdPs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations/{externalIntegrationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get identifiers for an integration
      effect: read
      questions:
      - Which identifiers belong to one external integration?
      - Can I page through one integration's identifiers?
      instructions:
      - text: Get identifiers for integration {id}.
        slots:
          id: path.externalIntegrationId
      - text: Show identifiers of integration {id} sorted by {sort}.
        slots:
          id: path.externalIntegrationId
          sort: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations/{externalIntegrationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one integration's identifiers
      effect: write
      questions:
      - How do I change the identifiers of one integration?
      - Can I replace identifiers on a single external integration?
      instructions:
      - text: Update identifiers of integration {id} to {ids}.
        slots:
          id: path.externalIntegrationId
          ids: requestBody.ExternalIntegrationIdentifiers
      - text: Replace identifiers on integration {id}.
        slots:
          id: path.externalIntegrationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations/{externalIntegrationId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add identifiers to one integration
      effect: write
      questions:
      - Can I add more identifiers to an existing integration?
      - How do I append identifiers to one external integration?
      instructions:
      - text: Add identifiers {ids} to integration {id}.
        slots:
          ids: requestBody.ExternalIntegrationIdentifiers
          id: path.externalIntegrationId
      - text: Append new identifiers to integration {id}.
        slots:
          id: path.externalIntegrationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations/{externalIntegrationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one integration's identifiers
      effect: destructive
      questions:
      - Can I remove the identifiers of a single integration?
      - How do I disconnect one external integration?
      instructions:
      - text: Remove identifiers of integration {id}.
        slots:
          id: path.externalIntegrationId
      - text: Disconnect external integration {id}.
        slots:
          id: path.externalIntegrationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an external identity integration
      effect: write
      questions:
      - How do I change the SAML settings of one integration?
      - Can I make an integration the default IdP?
      instructions:
      - text: Edit integration {id} display name to {name}.
        slots:
          id: path.id
          name: query.DisplayName
      - text: Set integration {id} default IdP to {default}.
        slots:
          id: path.id
          default: query.DefaultIdp
      method: generated
      generated: '2026-10-01'