Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud SSO Identity Provider API

8 actions 8 updates phrasing extends openapi/aembit-sso-identity-provider-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Aembit's API. It is a proposal applied on top of the contract, not a document Aembit publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/v1/sso-idps/{id}/verification'].get

$.paths['/api/v1/sso-idps/{id}'].get

$.paths['/api/v1/sso-idps/{id}'].delete

$.paths['/api/v1/sso-idps/{id}'].patch

$.paths['/api/v1/sso-idps'].get

$.paths['/api/v1/sso-idps'].put

$.paths['/api/v1/sso-idps'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aembit Cloud SSO Identity Provider API
  version: 1.0.0
extends: openapi/aembit-sso-identity-provider-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: 7
- target: $.paths['/api/v1/sso-idps/{id}/verification'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify an SSO identity provider
      effect: read
      questions:
      - Is my SSO identity provider fully configured?
      - How do I check an SSO identity provider has all the data it needs?
      instructions:
      - text: Verify SSO identity provider {id}.
        slots:
          id: path.id
      - text: Check that identity provider {id} is ready for single sign-on.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sso-idps/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SSO identity provider
      effect: read
      questions:
      - What is configured on a specific SSO identity provider?
      - Can I read one SSO identity provider by ID?
      instructions:
      - text: Show SSO identity provider {id}.
        slots:
          id: path.id
      - text: Get the configuration of identity provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sso-idps/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSO identity provider
      effect: destructive
      questions:
      - Can I remove an SSO identity provider?
      - What is the call to delete an identity provider by ID?
      instructions:
      - text: Delete SSO identity provider {id}.
        slots:
          id: path.id
      - text: Remove identity provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sso-idps/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle an SSO identity provider
      effect: write
      questions:
      - Can I disable an SSO identity provider temporarily?
      - Is it possible to rename an identity provider?
      instructions:
      - text: Deactivate SSO identity provider {id}.
        slots:
          id: path.id
      - text: Rename identity provider {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sso-idps'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSO identity providers
      effect: read
      questions:
      - Which SSO identity providers are connected to my tenant?
      - Can I filter the identity provider list?
      instructions:
      - text: List my SSO identity providers.
      - text: List identity providers matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sso-idps'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an SSO identity provider
      effect: write
      questions:
      - How do I fully update an SSO identity provider's settings?
      - Can I overwrite an identity provider's configuration?
      instructions:
      - text: Replace an SSO identity provider's configuration.
      - text: Overwrite the settings of an existing identity provider.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/sso-idps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an SSO identity provider
      effect: write
      questions:
      - How do I connect a new SSO identity provider?
      - Can I set up single sign-on for my tenant's admins?
      instructions:
      - text: Create an SSO identity provider.
      - text: Add a new identity provider for single sign-on.
      method: generated
      generated: '2026-09-26'