# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Ldap Settings API
  version: 1.0.0
extends: openapi/harness-ldap-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: 19
- target: $.paths['/v1/ldap-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account's LDAP settings
      effect: read
      questions:
      - What LDAP configuration is set up for my Harness account?
      - Is LDAP login already configured on this account?
      instructions:
      - text: Show the LDAP settings configured for my account.
      - text: Get the LDAP settings for account {account}.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create LDAP settings for the account
      effect: write
      questions:
      - How do I set up LDAP authentication for my account from scratch?
      - Can I add an LDAP directory configuration through the API?
      instructions:
      - text: Create account LDAP settings using configuration {settings}.
        slots:
          settings: requestBody.ldap_settings
      - text: Add a new LDAP configuration {settings} to account {account}.
        slots:
          settings: requestBody.ldap_settings
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/{ldap-settings-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get LDAP settings by identifier
      effect: read
      questions:
      - Can I look up a specific LDAP configuration by its ID?
      - What host and query settings does a given LDAP settings record hold?
      instructions:
      - text: Get LDAP settings {ldap_id}.
        slots:
          ldap_id: path.ldap-settings-id
      - text: Show the LDAP configuration with ID {ldap_id}.
        slots:
          ldap_id: path.ldap-settings-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/{ldap-settings-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update existing LDAP settings
      effect: write
      questions:
      - How do I change the connection details of an existing LDAP configuration?
      - Can I edit LDAP settings in place without recreating them?
      instructions:
      - text: Update LDAP settings {ldap_id} with {settings}.
        slots:
          ldap_id: path.ldap-settings-id
          settings: requestBody.ldap_settings
      - text: Replace the configuration of LDAP settings {ldap_id}.
        slots:
          ldap_id: path.ldap-settings-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/{ldap-settings-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete LDAP settings
      effect: destructive
      questions:
      - How do I remove the LDAP configuration from my account?
      - What happens to LDAP sign-in if I delete the settings record?
      instructions:
      - text: Delete LDAP settings {ldap_id}.
        slots:
          ldap_id: path.ldap-settings-id
      - text: Remove the LDAP configuration {ldap_id} from the account.
        slots:
          ldap_id: path.ldap-settings-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/validate/connection-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Test LDAP connection settings
      effect: read
      questions:
      - Can I check that Harness can reach my LDAP server before saving the config?
      - Is my LDAP host, port and bind account working?
      instructions:
      - text: Test the LDAP connection settings in {settings}.
        slots:
          settings: requestBody.ldap_settings
      - text: Validate that the LDAP server connection in {settings} succeeds.
        slots:
          settings: requestBody.ldap_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/validate/user-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Test LDAP user query settings
      effect: read
      questions:
      - Does my LDAP user search base and filter actually find users?
      - Can I verify the user query part of an LDAP config on its own?
      instructions:
      - text: Validate the LDAP user query settings in {settings}.
        slots:
          settings: requestBody.ldap_settings
      - text: Check whether the user lookup in LDAP config {settings} returns users.
        slots:
          settings: requestBody.ldap_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/validate/group-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Test LDAP group query settings
      effect: read
      questions:
      - Will my LDAP group search settings find the groups I expect?
      - Can I test just the group query of an LDAP configuration?
      instructions:
      - text: Validate the LDAP group query settings in {settings}.
        slots:
          settings: requestBody.ldap_settings
      - text: Check whether the group lookup in LDAP config {settings} returns groups.
        slots:
          settings: requestBody.ldap_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/sync-groups'].put
  update:
    x-apievangelist-phrasing:
      intent: Sync all LDAP-linked user groups
      effect: write
      questions:
      - How do I force every LDAP-linked user group to resync membership now?
      - Can I trigger a full LDAP group sync for the account without waiting for the schedule?
      instructions:
      - text: Sync all LDAP-linked user groups now.
      - text: Run an LDAP group membership sync for account {account}.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/sync-group/{group-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Sync one user group from LDAP
      effect: write
      questions:
      - Can I resync just a single user group's members from LDAP?
      - How do I refresh one LDAP-backed group without syncing them all?
      instructions:
      - text: Sync user group {group} from LDAP.
        slots:
          group: path.group-id
      - text: Refresh the LDAP membership of user group {group}.
        slots:
          group: path.group-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/search-group/{group-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Search LDAP groups by name
      effect: read
      questions:
      - Which LDAP groups match a name I'm looking for?
      - Can I search the directory for a group before linking it?
      instructions:
      - text: Search LDAP groups matching {name}.
        slots:
          name: path.group-id
      - text: Find directory groups named like {name}.
        slots:
          name: path.group-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/link/{group-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an account user group to an LDAP group
      effect: write
      questions:
      - How do I tie an account-level user group to an LDAP group?
      - Can an account user group get its members from a directory group?
      instructions:
      - text: Link account user group {group} to LDAP group {sso_group_name} ({sso_group_id}) using LDAP settings {sso_id}.
        slots:
          group: path.group-id
          sso_group_name: requestBody.sso_group_name
          sso_group_id: requestBody.sso_group_id
          sso_id: requestBody.sso_id
      - text: Bind account user group {group} to LDAP group {sso_group_id}.
        slots:
          group: path.group-id
          sso_group_id: requestBody.sso_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/unlink/{group-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink an account user group from LDAP
      effect: destructive
      questions:
      - How do I detach an account-level user group from its LDAP group?
      - Can I keep the current members when unlinking an account group from LDAP?
      instructions:
      - text: Unlink account user group {group} from LDAP.
        slots:
          group: path.group-id
      - text: Unlink account user group {group} from LDAP and set retain members to {retain}.
        slots:
          group: path.group-id
          retain: requestBody.retain_members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/unlink/orgs/{org}/{group-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink an org user group from LDAP
      effect: destructive
      questions:
      - How do I detach an organization's user group from its LDAP group?
      - Can an org-level group keep its members after I unlink it from the directory?
      instructions:
      - text: Unlink user group {group} in org {org} from LDAP.
        slots:
          group: path.group-id
          org: path.org
      - text: 'Unlink org {org} user group {group} from LDAP, retain members: {retain}.'
        slots:
          org: path.org
          group: path.group-id
          retain: requestBody.retain_members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/link/orgs/{org}/{group-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an org user group to an LDAP group
      effect: write
      questions:
      - How do I connect a user group inside an organization to an LDAP group?
      - Can org-scoped user groups be driven by directory membership?
      instructions:
      - text: Link user group {group} in org {org} to LDAP group {sso_group_id}.
        slots:
          group: path.group-id
          org: path.org
          sso_group_id: requestBody.sso_group_id
      - text: Bind org {org} user group {group} to LDAP group {sso_group_name} via LDAP settings {sso_id}.
        slots:
          org: path.org
          group: path.group-id
          sso_group_name: requestBody.sso_group_name
          sso_id: requestBody.sso_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/unlink/orgs/{org}/projects/{project}/{group-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink a project user group from LDAP
      effect: destructive
      questions:
      - How do I detach a project-level user group from LDAP?
      - Can a project user group keep its members once unlinked from the directory?
      instructions:
      - text: Unlink user group {group} in project {project} of org {org} from LDAP.
        slots:
          group: path.group-id
          project: path.project
          org: path.org
      - text: 'Unlink project {project} user group {group} in org {org} from LDAP, retain members: {retain}.'
        slots:
          project: path.project
          group: path.group-id
          org: path.org
          retain: requestBody.retain_members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/link/orgs/{org}/projects/{project}/{group-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a project user group to an LDAP group
      effect: write
      questions:
      - How do I link a user group inside a project to an LDAP group?
      - Can project-scoped user groups sync members from LDAP?
      instructions:
      - text: Link user group {group} in project {project} of org {org} to LDAP group {sso_group_id}.
        slots:
          group: path.group-id
          project: path.project
          org: path.org
          sso_group_id: requestBody.sso_group_id
      - text: Bind project {project} user group {group} in org {org} to LDAP group {sso_group_name}.
        slots:
          project: path.project
          group: path.group-id
          org: path.org
          sso_group_name: requestBody.sso_group_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/iterations'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview LDAP sync schedule runs
      effect: read
      questions:
      - When would an LDAP sync cron expression next run?
      - Can I check upcoming iterations of an LDAP group sync schedule?
      instructions:
      - text: Show the next LDAP sync iterations for cron {cron}.
        slots:
          cron: requestBody.cron
      - text: Preview when LDAP sync schedule {cron} will fire.
        slots:
          cron: requestBody.cron
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ldap-settings/ldap-login-test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an LDAP user login
      effect: read
      questions:
      - Can a specific user actually sign in with my LDAP configuration?
      - How do I test LDAP login with a real email and password?
      instructions:
      - text: Test LDAP login for {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Check whether {email} can authenticate through LDAP.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'