# 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 Security API
  version: 1.0.0
extends: openapi/cohesity-security-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: 16
- target: $.paths['/clientcsr'].post
  update:
    x-apievangelist-phrasing:
      intent: Create client and server CSR pair
      effect: write
      questions:
      - How do I generate both a client and a server certificate signing request at once?
      - Can a service have more than one outstanding client/server CSR pair?
      instructions:
      - text: Create a client and server CSR pair for {organization}, {organizationUnit}, {city}, {state}, {countryCode}.
        slots:
          organization: requestBody.organization
          organizationUnit: requestBody.organizationUnit
          city: requestBody.city
          state: requestBody.state
          countryCode: requestBody.countryCode
      - text: Generate client and server CSRs for service {serviceName} with common name {commonName}.
        slots:
          serviceName: requestBody.serviceName
          commonName: requestBody.commonName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clientcsr/certificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Import signed client and server certificates
      effect: write
      questions:
      - Once my CA signs the client/server CSR pair, how do I load both certificates back?
      - Do I need to import the client and server certificates together?
      instructions:
      - text: Import server certificate {certificateServer} and client certificate {certificateClient}.
        slots:
          certificateServer: requestBody.certificateServer
          certificateClient: requestBody.certificateClient
      - text: Install the signed client cert {certificateClient} and server cert {certificateServer} from my CSR pair.
        slots:
          certificateClient: requestBody.certificateClient
          certificateServer: requestBody.certificateServer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/csr'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate signing requests
      effect: read
      questions:
      - Which certificate signing requests are pending on the cluster?
      - Can I list CSRs for just one service?
      instructions:
      - text: List all CSRs on the cluster.
      - text: Show the CSRs for service {serviceName}.
        slots:
          serviceName: query.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/csr'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a single certificate signing request
      effect: write
      questions:
      - How do I generate one CSR for a cluster service's certificate?
      - Can I choose the key algorithm and size for a CSR?
      - Which subject alternative names can I put on a CSR?
      instructions:
      - text: Create a CSR for {organization}, {organizationUnit} in {city}, {state}, {countryCode}.
        slots:
          organization: requestBody.organization
          organizationUnit: requestBody.organizationUnit
          city: requestBody.city
          state: requestBody.state
          countryCode: requestBody.countryCode
      - text: Generate a CSR with DNS names {dnsNames} and a {keySizeBits}-bit key.
        slots:
          dnsNames: requestBody.dnsNames
          keySizeBits: requestBody.keySizeBits
      method: generated
      generated: '2026-10-01'
- target: $.paths['/csr/certificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Install a signed certificate for a CSR
      effect: write
      questions:
      - Where do I upload the certificate my CA returned for a single CSR?
      - Does the signed certificate need to reference the CSR id?
      instructions:
      - text: Install certificate {certificate} for CSR {csrId}.
        slots:
          certificate: requestBody.certificate
          csrId: requestBody.csrId
      - text: Attach the signed cert {certificate} to the request {csrId}.
        slots:
          certificate: requestBody.certificate
          csrId: requestBody.csrId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/csr/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a certificate signing request
      effect: read
      questions:
      - Can I view the contents of one CSR so I can send it to my CA?
      - What details are stored on a specific CSR?
      instructions:
      - text: Get CSR {id}.
        slots:
          id: path.id
      - text: Show me the certificate signing request with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/csr/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a certificate signing request
      effect: destructive
      questions:
      - How do I discard a CSR so I can create a new one for the same service?
      - Is deleting a CSR permanent?
      instructions:
      - text: Delete CSR {id}.
        slots:
          id: path.id
      - text: Remove the outstanding signing request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cluster security settings
      effect: read
      questions:
      - What password strength and lockout rules are set on my cluster?
      - Is certificate-based authentication turned on for the cluster?
      instructions:
      - text: Show the cluster security settings.
      - text: Get the current password and session security configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security-config'].put
  update:
    x-apievangelist-phrasing:
      intent: Update cluster security settings
      effect: write
      questions:
      - How do I tighten password reuse and lifetime rules on the cluster?
      - Can I change the account lockout policy or user session timeouts?
      instructions:
      - text: Set the account lockout policy to {accountLockout}.
        slots:
          accountLockout: requestBody.accountLockout
      - text: Update password strength rules to {passwordStrength}.
        slots:
          passwordStrength: requestBody.passwordStrength
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/ciphers'].get
  update:
    x-apievangelist-phrasing:
      intent: List enabled TLS ciphers
      effect: read
      questions:
      - Which ciphers are enabled on my cluster?
      - Are any weak ciphers still turned on?
      instructions:
      - text: List the ciphers enabled on the cluster.
      - text: Show the active cipher suites.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/ciphers'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable cluster ciphers
      effect: write
      questions:
      - How do I disable specific ciphers on the cluster?
      - Does changing ciphers require a service restart to take effect?
      instructions:
      - text: Disable ciphers {ciphers} on the cluster.
        slots:
          ciphers: requestBody.ciphers
      - text: Set cipher enablement to {enable} for {ciphers}.
        slots:
          enable: requestBody.enable
          ciphers: requestBody.ciphers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/trusted-cas'].get
  update:
    x-apievangelist-phrasing:
      intent: List trusted CA certificates
      effect: read
      questions:
      - Which CA certificates are in the cluster trust store?
      - Can I look up trusted CAs by name?
      instructions:
      - text: List all trusted CA certificates.
      - text: Show trusted CAs named {names}.
        slots:
          names: query.names
      method: generated
      generated: '2026-10-01'
- target: $.paths['/trusted-cas'].post
  update:
    x-apievangelist-phrasing:
      intent: Add CA certificates to the trust store
      effect: write
      questions:
      - How do I add my internal CA to the cluster trust store?
      - Can I validate a CA certificate without actually importing it?
      instructions:
      - text: Register CA certificates {certificates} in the trust store.
        slots:
          certificates: requestBody.certificates
      - text: Only validate CA certificates {certificates} without saving them.
        slots:
          certificates: requestBody.certificates
      method: generated
      generated: '2026-10-01'
- target: $.paths['/trusted-cas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trusted CA certificate
      effect: read
      questions:
      - What are the details of one trusted CA certificate?
      - When does a specific trusted CA expire?
      instructions:
      - text: Get trusted CA certificate {id}.
        slots:
          id: path.id
      - text: Show the trust store entry with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/trusted-cas/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a CA from the trust store
      effect: destructive
      questions:
      - How do I stop trusting a CA certificate on the cluster?
      - Will removing a trusted CA break connections that rely on it?
      instructions:
      - text: Unregister trusted CA {id}.
        slots:
          id: path.id
      - text: Remove CA certificate {id} from the trust store.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/trusted-cas/{id}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a trusted CA certificate
      effect: read
      questions:
      - Can I check whether a trusted CA certificate has expired or been revoked?
      - Is a CA already in the trust store still valid?
      instructions:
      - text: Validate trusted CA {id} for expiration and revocation.
        slots:
          id: path.id
      - text: Check if trust store certificate {id} is still valid.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'