# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Idps API
  version: 1.0.0
extends: openapi/cohesity-idps-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/public/idp/principals'].post
  update:
    x-apievangelist-phrasing:
      intent: Add IdP users or groups with roles
      effect: write
      questions:
      - How do I give SSO users from my identity provider access to the cluster?
      - Can I map Cohesity roles to IdP groups?
      instructions:
      - text: Add IdP principals to the cluster and assign their Cohesity roles.
      - text: Grant cluster access to identity provider groups with mapped roles.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/idps'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity provider configurations
      effect: read
      questions:
      - Which SAML identity providers are configured on the cluster?
      - Can I filter IdPs by domain or tenant?
      instructions:
      - text: List the IdP configurations on the cluster.
      - text: Show identity providers for domain {domains}.
        slots:
          domains: query.domains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/idps'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure a SAML identity provider
      effect: write
      questions:
      - How do I set up SAML single sign-on for the cluster?
      - Can I add an IdP with its SSO URL and certificate?
      instructions:
      - text: Create IdP {name} for domain {domain} with SSO URL {ssoUrl}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          ssoUrl: requestBody.ssoUrl
      - text: Add identity provider {name} with issuer {issuerId}.
        slots:
          name: requestBody.name
          issuerId: requestBody.issuerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/idps/login'].get
  update:
    x-apievangelist-phrasing:
      intent: Log in through an identity provider
      effect: read
      questions:
      - How do I sign in to the cluster using SSO?
      - Can a tenant log in via its own IdP?
      instructions:
      - text: Start an IdP login to the cluster.
      - text: Redirect me to the SSO login for tenant {tenantId}.
        slots:
          tenantId: query.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/idps/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an identity provider configuration
      effect: write
      questions:
      - Can I rotate the certificate on an existing SAML IdP?
      - How do I change the SSO URL of an IdP I set up?
      instructions:
      - text: Update the SSO URL of IdP {id} to {ssoUrl}.
        slots:
          id: path.id
          ssoUrl: requestBody.ssoUrl
      - text: Replace the certificate on IdP {id} with {certificate}.
        slots:
          id: path.id
          certificate: requestBody.certificate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/idps/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity provider configuration
      effect: destructive
      questions:
      - How do I remove a SAML IdP from the cluster?
      - Can I delete an IdP configuration by id?
      instructions:
      - text: Delete IdP configuration {id}.
        slots:
          id: path.id
      - text: Remove identity provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'