ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dex Organization Settings API

3 actions 3 updates phrasing extends openapi/controlup-organization-settings-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 3

$.info
$.paths['/organizations/{orgId}/settings'].get
$.paths['/organizations/{orgId}/settings'].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 Dex Organization Settings API
  version: 1.0.0
extends: openapi/controlup-organization-settings-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: 2
- target: $.paths['/organizations/{orgId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization settings
      effect: read
      questions:
      - What login methods, MFA and session timeouts is my organization configured with?
      - Is the IP allowlist currently enabled for my organization?
      instructions:
      - text: Get the settings of organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Show the current security settings for {orgId}.
        slots:
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update organization settings
      effect: write
      questions:
      - How do I change the inactivity session timeout for my organization?
      - Can I turn on the IP allowlist or restrict which MFA methods are allowed?
      instructions:
      - text: Set the inactivity session timeout for {orgId} to {sessionTimeoutInMinutes} minutes.
        slots:
          orgId: path.orgId
          sessionTimeoutInMinutes: requestBody.sessionTimeoutInMinutes
      - text: Set IP allowlist enforcement for organization {orgId} to {ipAllowlistEnabled}.
        slots:
          ipAllowlistEnabled: requestBody.ipAllowlistEnabled
          orgId: path.orgId
      - text: Restrict {orgId} to MFA methods {mfas}.
        slots:
          mfas: requestBody.mfas
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'