Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Identity Providers API

7 actions 7 updates phrasing extends openapi/acquia-identity-providers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Acquia's API. It is a proposal applied on top of the contract, not a document Acquia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/identity-providers'].get
$.paths['/identity-providers/{identityProviderUuid}'].get
$.paths['/identity-providers/{identityProviderUuid}'].put
$.paths['/identity-providers/{identityProviderUuid}'].delete
$.paths['/identity-providers/{identityProviderUuid}/actions/enable'].post
$.paths['/identity-providers/{identityProviderUuid}/actions/disable'].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 Acquia Cloud API Documentation Identity Providers API
  version: 1.0.0
extends: openapi/acquia-identity-providers-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: 6
- target: $.paths['/identity-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List my identity providers
      effect: read
      questions:
      - Which SAML identity providers are set up for single sign-on?
      - Can I search my identity providers by label?
      instructions:
      - text: List the identity providers I can access.
      - text: Show identity providers matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identity-providers/{identityProviderUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity provider
      effect: read
      questions:
      - What SSO URL and entity ID does an identity provider use?
      - Can I look up one identity provider by UUID?
      instructions:
      - text: Show identity provider {identityProviderUuid}.
        slots:
          identityProviderUuid: path.identityProviderUuid
      - text: Get the SSO configuration of identity provider {identityProviderUuid}.
        slots:
          identityProviderUuid: path.identityProviderUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identity-providers/{identityProviderUuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an identity provider
      effect: write
      questions:
      - How do I rotate the signing certificate on my identity provider?
      - Can I change the SSO URL or entity ID of an existing identity provider?
      instructions:
      - text: Replace the certificate on identity provider {identityProviderUuid} with {certificate}.
        slots:
          identityProviderUuid: path.identityProviderUuid
          certificate: requestBody.certificate
      - text: Set identity provider {identityProviderUuid} SSO URL to {sso_url} and entity ID to {entity_id}.
        slots:
          identityProviderUuid: path.identityProviderUuid
          sso_url: requestBody.sso_url
          entity_id: requestBody.entity_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identity-providers/{identityProviderUuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity provider
      effect: destructive
      questions:
      - Can I delete an identity provider we stopped using?
      - How do I remove an SSO identity provider completely?
      instructions:
      - text: Delete identity provider {identityProviderUuid}.
        slots:
          identityProviderUuid: path.identityProviderUuid
      - text: Remove SSO identity provider {identityProviderUuid} permanently.
        slots:
          identityProviderUuid: path.identityProviderUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identity-providers/{identityProviderUuid}/actions/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable an identity provider
      effect: write
      questions:
      - How do I turn on single sign-on through an identity provider?
      - Can I activate an identity provider I just configured?
      instructions:
      - text: Enable identity provider {identityProviderUuid}.
        slots:
          identityProviderUuid: path.identityProviderUuid
      - text: Switch on SSO via identity provider {identityProviderUuid}.
        slots:
          identityProviderUuid: path.identityProviderUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identity-providers/{identityProviderUuid}/actions/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable an identity provider
      effect: write
      questions:
      - Can I temporarily turn off an identity provider without deleting it?
      - How do I pause SSO for an identity provider?
      instructions:
      - text: Disable identity provider {identityProviderUuid}.
        slots:
          identityProviderUuid: path.identityProviderUuid
      - text: Switch off SSO via identity provider {identityProviderUuid} but keep its settings.
        slots:
          identityProviderUuid: path.identityProviderUuid
      method: generated
      generated: '2026-09-26'