SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Single Sign-On SSO Settings API

6 actions 6 updates phrasing extends openapi/sendgrid-sso-settings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v3/sso/integrations'].get
$.paths['/v3/sso/integrations'].post
$.paths['/v3/sso/integrations/{id}'].get
$.paths['/v3/sso/integrations/{id}'].delete
$.paths['/v3/sso/integrations/{id}'].patch

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 Twilio SendGrid Single Sign-On SSO Settings API
  version: 1.0.0
extends: openapi/sendgrid-sso-settings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v3/sso/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSO integrations
      effect: read
      questions:
      - Which single sign-on identity providers are connected to my account?
      - Can I include the IdP certificate details when listing SSO integrations?
      instructions:
      - text: List all my SSO integrations.
      - text: 'Show SSO integrations with certificate info included: {si}.'
        slots:
          si: query.si
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/sso/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a SAML single sign-on provider
      effect: write
      questions:
      - How do I set up SAML single sign-on for my team?
      - What IdP details are required, such as sign-in URL and entity ID?
      instructions:
      - text: Create SSO integration {name} with sign-in {signin_url}, sign-out {signout_url}, entity {entity_id}, enabled {enabled}.
        slots:
          name: requestBody.name
          signin_url: requestBody.signin_url
          signout_url: requestBody.signout_url
          entity_id: requestBody.entity_id
          enabled: requestBody.enabled
      - text: Add a new IdP named {name} using entity ID {entity_id}, sign-in {signin_url}, sign-out {signout_url}, enabled {enabled}.
        slots:
          name: requestBody.name
          entity_id: requestBody.entity_id
          signin_url: requestBody.signin_url
          signout_url: requestBody.signout_url
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/sso/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one SSO integration
      effect: read
      questions:
      - What sign-in URL and entity ID does a particular SSO integration use?
      - Is a specific SSO integration enabled?
      instructions:
      - text: Show SSO integration {id}.
        slots:
          id: path.id
      - text: Get the IdP settings for SSO integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/sso/integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSO integration
      effect: destructive
      questions:
      - Can I remove an identity provider configuration I no longer use?
      - What ID do I need to disconnect an SSO integration?
      instructions:
      - text: Delete SSO integration {id}.
        slots:
          id: path.id
      - text: Remove the IdP configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/sso/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify an existing SSO integration
      effect: write
      questions:
      - Can I change the sign-in URL of an SSO integration I already set up?
      - How do I disable an existing SSO integration without deleting it?
      instructions:
      - text: 'Update SSO integration {id}: name {name}, sign-in {signin_url}, sign-out {signout_url}, entity {entity_id}, enabled {enabled}.'
        slots:
          id: path.id
          name: requestBody.name
          signin_url: requestBody.signin_url
          signout_url: requestBody.signout_url
          entity_id: requestBody.entity_id
          enabled: requestBody.enabled
      - text: 'Mark existing SSO integration {id} as completed: {completed_integration}.'
        slots:
          id: path.id
          completed_integration: requestBody.completed_integration
      method: generated
      generated: '2026-09-24'