toc.yaml

toc:
  properties:
    subcollection: key-protect
    service-name: kms
    category: security
    audience: service
    href: /docs/key-protect
    console-page: /catalog/services/key-protect
    product-page: https://ibm.com/products/key-protect
    path: key-protect
    label: Key Protect
  entries:
  - navgroup:
      id: learn
      topics:
      - topic: index.md
        navtitle: Getting started
      - topicgroup:
          label: About
          topics:
          - about.md
          - topicgroup:
              label: Pricing
              topics:
              - pricing-about.md
              - topic: pricing-plan.md
                navtitle: On IBM Cloud
              - topic: pricing-plan-satellite.md
                navtitle: On Satellite
          - service-comparison.md
          - concepts/manage-access.md
          - topic: shared-responsibilities.md
            navtitle: Your responsibilies
      - topicgroup:
          label: Use cases
          topics:
          - concepts/envelope-encryption.md
          - concepts/quantum-safe-cryptography.md
      - topicgroup:
          label: Best practices
          topics:
          - concepts/importing-keys.md
          - concepts/key-states.md
          - concepts/key-rotation.md
      - topic: releases.md
        navtitle: Release notes
  - navgroup:
      id: tutorial
      topics:
          - tutorials/secure-import.md
          - link:
              label: Apply end to end security to a cloud application
              href: https://{DomainName}/docs/tutorials?topic=solution-tutorials-cloud-e2e-security
          - link:
              label: Enhance the security of your deployed application
              href: https://{DomainName}/docs/tutorials?topic=solution-tutorials-extended-app-security
  - navgroup:
      id: howto
      topics: 
      - topicgroup:
          label: Setting up the service
          topics:
          - provision.md
          - grant-access-keys.md
          - topicgroup:
              label: Integrations
              topics:
              - integrations/integrate-services.md
              - integrations/integrate-cos.md
              - integrations/view-protected-resources.md
              - integrations/sync-resources.md
          - topicgroup:
              label: Deploying Key Protect on Satellite
              topics:
              - satellite/satellite-about.md
              - satellite/satellite-hsm-deploy.md
              - satellite/satellite-ui-deploy.md
          - topicgroup:
              label: Accessing the API
              topics:
              - set-up-api.md
              - retrieve-access-token.md
              - retrieve-instance-id.md
              - private-network.md
              - virtual-private-endpoints.md
          - set-up-cli.md
      - topicgroup:
          label: Working with keys
          topics:
          - topicgroup:
              label: Creating and importing keys
              topics:
              - create-root-keys.md
              - create-standard-keys.md
              - create-key-alias.md
              - import-root-keys.md
              - import-standard-keys.md
              - create-import-tokens.md
              - settings-key-create-import-access.md
              - manage-dual-auth.md
          - topicgroup:
               label: Retrieving keys
               topics:
               - topic: view-keys.md
                 navtitle: Retrieving a list of keys
               - retrieve-key.md
               - view-key-details.md
          - topicgroup:
               label: Wrapping and unwrapping keys
               topics:
               - wrap-keys.md
               - unwrap-keys.md
               - rewrap-keys.md
          - topicgroup:
              label: Rotating keys
              topics:
              - set-rotation-policy.md
              - rotate-keys.md
              - view-key-versions.md
          - topicgroup:
              label: Deleting keys
              topics:
              - delete-purge-keys.md
              - disable-keys.md
              - delete-keys.md
          - restore-keys.md
          - key-rings.md
          - kmip.md
      - topicgroup:
          label: Logging and monitoring
          topics:
          - at-events.md
          - settings-monitor-metrics.md
          - monitor-metrics.md
      - topicgroup:
          label: Enhancing security
          topics:
          - data-security.md
          - cbr-controlled-access.md
  - navgroup:
      id: reference
      topics:
      - link:
          label: Key Protect API reference
          href: https://{DomainName}/apidocs/key-protect
      - topicgroup:
          label: Key Protect CLI reference
          topics:
          - key-protect-cli-commands.md
          - cli-changelog.md
      - data_portability.md
      - topic: service-dependency.md
        navtitle: Service dependency map
      - topicgroup:
          label: Service availability
          topics:
          - regions.md
          - ha-dr.md
  - navgroup:
      id: help
      topics:
      - FAQs.md
      - error-messages.md
      - troubleshooting.md