Gerenciando a chave API do usuário

Certas operações exigem uma chave de API para autorização segura. Você pode gerar e alternar uma chave de API de usuário conforme necessário para ajudar a garantir que suas operações sejam executadas sem problemas.

Visão geral da chave API do usuário

As operações que estão sendo executadas nos serviços da plataforma exigem uma chave de API para autorização. Uma chave de API válida é necessária para as seguintes tarefas de longa duração:

  • Treinamento de modelo em tempo de execução watsonx.ai

  • Resolvendo problemas com o Decision Optimization

  • Pipelines

  • Outros serviços de tempo de execução que aceitam referências de chave de API

  • Limpeza e validação de dados com Data Refinery

  • Transformação de dados com fluxos do DataStage

Os trabalhos exigem uma chave de API para autorização. Uma chave API é usada para tarefas quando:

  • Criando um planejamento de tarefa com uma chave predefinida
  • Atualizando a chave API para uma tarefa planejada
  • Fornecendo uma chave de API para uma tarefa ad hoc

As chaves de API do usuário dão controle ao proprietário da conta para proteger e renovar as credenciais, ajudando assim a garantir que as operações sejam executadas sem interrupção. As chaves são exclusivas para o IBMid e conta. Se você alterar a conta na qual está trabalhando, deverá gerar uma nova chave.

Funções necessárias
Função na plataforma IAM: Administrador ou proprietário da conta

Limitações:

  • Se você estiver conectado por meio de um perfil confiável, dependendo das configurações do perfil, talvez não tenha a opção de gerar ou alternar chaves de API. Em vez disso, você deve usar uma chave de API que foi gerada por um dos membros estáticos do perfil. Para obter mais informações, consulte Visão geral da configuração de perfis confiáveis.

Acessando a lista de chaves API do usuário

Observação: você não pode visualizar a chave API real dessa forma.

Para visualizar a lista de chaves de API:

  1. Clique em seu avatar e selecione Perfil e Configurações para abrir seu perfil de conta
  2. Selecione User API key (Chave de API do usuário ) para visualizar as chaves ativas e as eliminadas.

Criando uma chave API de usuário

Para criar uma chave API de usuário:

  1. Clique em seu avatar e selecione Perfil e Configurações para abrir seu perfil de conta
  2. Selecione a chave de API do usuário.
  3. Clique em Criar uma chave.

Uma nova chave é criada no estado Ativo A chave autoriza automaticamente operações que exigem credenciais seguras.

Observação: você não pode visualizar a nova chave API do usuário. Destina-se apenas a uso interno. Por exemplo, para uso em tarefas ou pipelines.
Nota:

Se a plataforma em que você está trabalhando for implantada em IBM Cloud, a chave de API do usuário também será armazenada em IBM Cloud. Você pode visualizar as chaves de API do usuário para sua conta IBM Cloud em Chaves de API. Em AWS, você não tem acesso às suas chaves de API de usuário no console IBM SaaS.

Rotação de uma chave API de usuário

Importante: as chaves de API em AWS expiram a cada 365 dias. Se os administradores deixarem a chave de API expirar, o ID de serviço que o serviço usa não poderá mais executar tarefas. Por exemplo, as entregas de produtos de dados não funcionarão em Data Product Hub. Para evitar a interrupção do serviço, altere sua chave de API antes que ela expire.

Se uma chave API de usuário se tornar obsoleta ou inválida, você pode gerar uma nova chave ativa para uso em todas as operações.

Para girar uma tecla:

  1. Clique em seu avatar e selecione Perfil e Configurações para abrir seu perfil de conta
  2. Selecione User API key (Chave de API do usuário ) para visualizar as chaves ativas e as eliminadas.
  3. Clique em Rotate (Girar ).

Ao girar uma chave, uma nova chave é criada no estado Ativo e a chave existente é mudada para o estado Deslocado . Uma chave eliminada gradualmente não é usada para autorização e pode ser excluída.

Excluindo uma chave API de usuário descontinuada

Aviso: A exclusão de chaves pode causar falha nas operações em execução.

Para excluir uma chave API de usuário descontinuada:

  1. Clique em seu avatar e selecione Perfil e Configurações para abrir seu perfil de conta
  2. Selecione User API key (Chave de API do usuário ) para visualizar as chaves ativas e as eliminadas.
  3. Clique no sinal de menos localizado ao lado da chave eliminada gradualmente.

Excluindo todas as chaves API do usuário

Aviso: A exclusão de chaves pode causar falha nas operações em execução.

Para excluir todas as chaves de API:

  1. Clique em seu avatar e selecione Perfil e Configurações para abrir seu perfil de conta
  2. Selecione User API key (Chave de API do usuário ) para visualizar as chaves ativas e as eliminadas.
  3. Clique no ícone da lixeira.

Saiba mais: