ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dex SSO Groups API

5 actions 5 updates phrasing extends openapi/controlup-sso-groups-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/organizations/{orgId}/sso-groups'].get

$.paths['/organizations/{orgId}/sso-groups'].post

$.paths['/organizations/{orgId}/sso-groups/{id}'].delete

$.paths['/organizations/{orgId}/sso-groups/{id}'].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 Dex SSO Groups API
  version: 1.0.0
extends: openapi/controlup-sso-groups-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: 4
- target: $.paths['/organizations/{orgId}/sso-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSO groups
      effect: read
      questions:
      - Which SSO groups are defined in my organization?
      - Can I find an SSO group by its external ID or display name?
      instructions:
      - text: List SSO groups in organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Find the SSO group with external ID {externalId} in org {orgId}.
        slots:
          externalId: query.externalId
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/sso-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SSO group
      effect: write
      questions:
      - Can I map an IdP group into ControlUp as a new SSO group?
      - What fields does a new SSO group need?
      instructions:
      - text: Create SSO group {displayName} with external ID {externalId} in org {orgId}.
        slots:
          displayName: requestBody.displayName
          externalId: requestBody.externalId
          orgId: path.orgId
      - text: Add a new SSO group for IdP group {externalId} in organization {orgId}, named {displayName}.
        slots:
          externalId: requestBody.externalId
          orgId: path.orgId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/sso-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSO group
      effect: destructive
      questions:
      - Can I remove an SSO group from my organization?
      - Is an SSO group deleted by its ID?
      instructions:
      - text: Delete SSO group {id} in organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Remove SSO group {id} from org {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/sso-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an SSO group
      effect: write
      questions:
      - Can I rename an existing SSO group?
      - Can I change the external ID an SSO group maps to?
      instructions:
      - text: Rename SSO group {id} in org {orgId} to {displayName}.
        slots:
          id: path.id
          orgId: path.orgId
          displayName: requestBody.displayName
      - text: Change the external ID of SSO group {id} in org {orgId} to {externalId}.
        slots:
          id: path.id
          orgId: path.orgId
          externalId: requestBody.externalId
      method: generated
      generated: '2026-09-26'