Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Sso Clients API

6 actions 6 updates phrasing extends openapi/optimizely-sso-clients-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/v1/admin/SsoClients'].get

$.paths['/api/v1/admin/SsoClients'].post

$.paths['/api/v1/admin/SsoClients(\'{clientId}\')'].get

$.paths['/api/v1/admin/SsoClients(\'{clientId}\')'].delete

$.paths['/api/v1/admin/SsoClients(\'{clientId}\')'].patch

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 Admin API V1 Sso Clients API
  version: 1.0.0
extends: openapi/optimizely-sso-clients-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: 5
- target: $.paths['/api/v1/admin/SsoClients'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSO clients
      effect: read
      questions:
      - Which SSO clients are registered with my commerce identity server?
      - Can I filter SSO clients to only the enabled ones?
      - How many OAuth clients are configured for single sign-on?
      instructions:
      - text: List all SSO clients.
      - text: List SSO clients matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} SSO clients ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SsoClients'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an SSO client
      effect: write
      questions:
      - How do I register a new OAuth client for single sign-on?
      - Can I set token lifetimes and redirect URIs when creating an SSO client?
      - Can a new SSO client be allowed refresh tokens and admin scope?
      instructions:
      - text: Register SSO client {clientId} named {clientName} using the {flow} flow.
        slots:
          clientId: requestBody.clientId
          clientName: requestBody.clientName
          flow: requestBody.flow
      - text: Create SSO client {clientId} with redirect URIs {redirectUris}.
        slots:
          clientId: requestBody.clientId
          redirectUris: requestBody.redirectUris
      - text: Add SSO client {clientId} with an access token lifetime of {accessTokenLifetime}.
        slots:
          clientId: requestBody.clientId
          accessTokenLifetime: requestBody.accessTokenLifetime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SsoClients(\'{clientId}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SSO client
      effect: read
      questions:
      - What flow, scopes and token lifetimes does one SSO client use?
      - Can I look up a single SSO client by its client ID?
      instructions:
      - text: Get SSO client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show the configuration of SSO client {clientId}.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SsoClients(\'{clientId}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSO client
      effect: destructive
      questions:
      - Can I remove an SSO client so it can no longer sign in?
      - Is it possible to delete an SSO client only if its ETag matches?
      instructions:
      - text: Delete SSO client {clientId}.
        slots:
          clientId: path.clientId
      - text: Delete SSO client {clientId} if its ETag is {etag}.
        slots:
          clientId: path.clientId
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SsoClients(\'{clientId}\')'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an SSO client
      effect: write
      questions:
      - How do I disable an existing SSO client?
      - Can I change the redirect URIs of an SSO client I already registered?
      instructions:
      - text: Set enabled to {enabled} on SSO client {clientId}.
        slots:
          clientId: path.clientId
          enabled: requestBody.enabled
      - text: Update the redirect URIs of SSO client {clientId} to {redirectUris}.
        slots:
          clientId: path.clientId
          redirectUris: requestBody.redirectUris
      method: generated
      generated: '2026-09-26'