# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Treasure Data TD SSO API
  version: 1.0.0
extends: openapi/treasure-data-sso-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: 8
- target: $.paths['/account/sso_setting'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account's SSO configuration
      effect: read
      questions:
      - Which identity provider is my Treasure Data account configured to use for SSO?
      - Can I check the current single sign-on settings for the account?
      instructions:
      - text: Show the account's SSO settings.
      - text: Get the identity provider configuration used for single sign-on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/sso_setting'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the account's SSO configuration
      effect: write
      questions:
      - Can an admin change the identity provider details on an existing SSO setup?
      - What do I send to modify the account's current SSO configuration?
      instructions:
      - text: Update the existing SSO settings to {sso_setting}.
        slots:
          sso_setting: requestBody.sso_setting
      - text: Modify the account's identity provider configuration with {sso_setting}.
        slots:
          sso_setting: requestBody.sso_setting
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/sso_setting'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure SSO for the account for the first time
      effect: write
      questions:
      - How do I connect an identity provider to an account that has no SSO yet?
      - Can an admin set up single sign-on from scratch?
      instructions:
      - text: Create an SSO configuration for the account using {sso_setting}.
        slots:
          sso_setting: requestBody.sso_setting
      - text: Set up a new identity provider for single sign-on with {sso_setting}.
        slots:
          sso_setting: requestBody.sso_setting
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/sso_setting'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the account's SSO configuration
      effect: destructive
      questions:
      - How do I remove the identity provider from my account?
      - Is it possible to turn off single sign-on for the whole account?
      instructions:
      - text: Delete the account's SSO settings.
      - text: Remove the identity provider configuration from the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/create_with_sso/{user_first_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user who signs in with SSO
      effect: write
      questions:
      - Can an admin add a new user who authenticates through single sign-on?
      - What details are needed to create an SSO-authenticated user?
      instructions:
      - text: Create an SSO user named {user_first_name} with email {email} and identifier {identifier}.
        slots:
          user_first_name: path.user_first_name
          email: requestBody.email
          identifier: requestBody.identifier
      - text: Add {user_first_name} ({email}) as a new user who logs in via SSO with identifier {identifier}.
        slots:
          user_first_name: path.user_first_name
          email: requestBody.email
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/enforce_sso/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Require a user to log in with SSO
      effect: write
      questions:
      - How do I make SSO mandatory for a specific user?
      - Can I stop a user from signing in with a password and force single sign-on?
      instructions:
      - text: Enforce SSO login for {user_email}.
        slots:
          user_email: path.user_email
      - text: Make single sign-on mandatory for user {user_email}.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/enable_sso/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow a user to log in with SSO
      effect: write
      questions:
      - Can I let a user choose single sign-on without making it required?
      - Which call permits one user to sign in through the identity provider?
      instructions:
      - text: Enable SSO as an allowed login method for {user_email}.
        slots:
          user_email: path.user_email
      - text: Permit user {user_email} to sign in with single sign-on.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/disable_sso/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Prohibit a user from logging in with SSO
      effect: write
      questions:
      - How do I block one user from signing in through single sign-on?
      - Can an admin turn SSO off for just a single person?
      instructions:
      - text: Disable SSO login for {user_email}.
        slots:
          user_email: path.user_email
      - text: Prohibit user {user_email} from signing in with single sign-on.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'