Configurando chamadas API do Unified Key Orchestrator- Unified Key Orchestrator Plan

É possível usar a API Unified Key Orchestrator para criar, recuperar e destruir modelos de chaves, chaves e keystores no IBM Cloud® Hyper Protect Crypto Services para Unified Key Orchestrator.

Configurar as chamadas API do Unified Key Orchestrator aplica-se apenas ao Plano Unified Key Orchestrator.

Ao usar a API do Unified Key Orchestrator para criar as chaves do KMS do IBM Cloud que estão instaladas em keystores internos do KMS, essas chaves são chaves raiz e podem ser usadas para criptografia de envelope Também é possível usar a API do serviço de gerenciamento de chave para criar chaves internas do KMS do IBM Cloud e executar ações em direção às chaves

Recuperando as suas credenciais do IBM Cloud

Para trabalhar com a API, é necessário gerar suas credenciais de serviço e autenticação. Conclua as etapas a seguir para coletar suas credenciais:

  1. Gere um token de acesso do IBM Cloud IAM.

  2. Recupere o ID da instância que identifica exclusivamente a instância do Hyper Protect Crypto Services.

Formando sua solicitação de API Unified Key Orchestrator

Ao fazer uma chamada API para o serviço, estruture sua solicitação de API de acordo com a maneira como você inicialmente provisionou sua instância do Hyper Protect Crypto Services.

Para construir sua solicitação, emparelhe um terminal em serviço regional com as credenciais de autenticação apropriadas. Por exemplo, se você criou uma instância de serviço para a região us-south, use o terminal a seguir e os cabeçalhos de API para procurar chaves em seu serviço:

Se você criar suas instâncias após 12 de abril de 2024 em determinadas regiões, poderá ser necessário usar os novos terminais de API com o novo formato como <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud A data de disponibilidade varia por região. Para obter mais informações sobre as regiões suportadas, as datas de disponibilidade e as novas URLs de terminal, consulte Novos terminais

curl --location --request GET 'https://<instance_ID>.uko.<region>.hs-crypto.appdomain.cloud/api/v4/managed_keys' \
    --header 'Authorization: Bearer <access_token>' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'UKO-Vault: <vault_id>'

  • Substitua <region> e <instance_ID> pela região e o número da porta do seu terminal de API. É possível obter o <region> e o <instance_ID> em seu painel da IU da instância de serviço provisionada por meio da Visão geral > Unified Key Orchestrator URL de terminal Ou, é possível recuperar dinamicamente a URL de terminal da API.

    Note que a faixa de porta de uma instância Hyper Protect Crypto Services está entre 8000- 19999.

  • Substitua <access_token> pelo seu serviço recuperado e credenciais de autenticação.

  • Substitua <vault_id> pelo ID da área segura que suas chaves são designadas.

Deseja rastrear suas solicitações de API no caso de algo sair errado? Quando você inclui o sinalizador -v como parte da solicitação cURL, você obtém um valor correlation-id nos cabeçalhos de resposta. É possível usar esse valor para correlacionar e rastrear a solicitação para fins de depuração.

O que vem a seguir

Você está pronto para iniciar o gerenciamento de suas chaves de criptografia e dados. Para saber mais sobre o gerenciamento programático de suas chaves, consulte o doc de referência da API do Unified Key Orchestrator.