Página Perfis de Segurança no Jitterbit API Manager

Introdução

Use a página Perfis de Segurança no API Manager para configurar e gerenciar perfis de segurança. Os perfis de segurança controlam o acesso dos usuários às APIs do API Manager.

Como alternativa, crie e gerencie perfis de segurança usando o Assistente de IA do APIM.

Para executar ações ou fazer edições na página Perfis de Segurança, é necessária uma função com permissão de Admin. Usuários em funções não administrativas com acesso ao ambiente de Leitura ou superior têm acesso somente leitura.

Para obter informações sobre perfis de segurança, consulte Perfis de segurança em Conceitos-chave.

Acessar a página Perfis de Segurança

Para acessar a página Perfis de Segurança, use o menu do portal Harmony para selecionar API Manager > Perfis de Segurança.

Cabeçalho da página Perfis de Segurança

O cabeçalho no topo da página Perfis de Segurança inclui uma caixa de pesquisa, filtros e um botão para criar um novo perfil de segurança:

• Filtros: Você pode filtrar perfis de segurança por qualquer uma das seguintes opções:

  

  • Tipo de autenticação: Selecione os tipos de autenticação para os perfis de segurança. As opções incluem OAuth 2.0, Chave de API, Básica ou Anônima. Quando todos os filtros estão desmarcados, aparecem perfis de segurança com qualquer tipo de autenticação.

  • Perfil de segurança padrão: Selecione se deseja mostrar perfis padrão ou não padrão.

  • Ambiente: Selecione os ambientes onde os perfis de segurança estão localizados. Quando todos os filtros estão desmarcados, aparecem perfis de segurança para todos os ambientes da sua organização (limitado aos ambientes que você pode acessar).

  • Status de expiração: Selecione um status de expiração de chave de API (Ativo, Expirando em breve ou Expirado) para filtrar perfis de segurança que usam o tipo de autenticação de chave de API. Quando nenhum status é selecionado, aparecem perfis de segurança com qualquer status de expiração.

  • Grupo de IP confiável: Selecione os grupos de IP confiáveis incluídos nos perfis de segurança.

• Pesquisa: Digite qualquer parte do nome de um perfil de segurança para filtrar perfis de segurança por nome. A pesquisa não diferencia maiúsculas de minúsculas.

• Filtrar colunas: Clique para alterar a disposição e a visibilidade das colunas. A gaveta Colunas é aberta:

  

  A gaveta inclui estes controles:

  • Mostrar tudo: Torna todas as colunas visíveis.
  • Mover: Arraste e solte para alterar a posição da coluna em relação às outras.
  • Ocultar: A coluna está visível. Clique para ocultá-la.
  • Mostrar: A coluna está oculta. Clique para mostrá-la.
  • Salvar: Salve as alterações da coluna.
  • Cancelar: Feche a gaveta de colunas sem salvar as alterações.

• Novo: Clique para selecionar uma das seguintes opções:

  • Criar com IA: Abre o Assistente do APIM para criar um perfil de segurança usando prompts em linguagem natural. Para obter mais informações, consulte Usando o Assistente de IA.

    Nota

    Para usar o Assistente de IA do APIM, sua licença do Harmony deve incluir a opção Assistente de IA do APIM. Entre em contato com seu Gerenciador de Sucesso do Cliente (CSM) para adicionar essa opção à sua licença.

  • Perfil de Segurança: Abre a gaveta de configuração do perfil de segurança para criar manualmente um novo perfil de segurança.

Configurar um perfil de segurança

A gaveta de configuração do perfil de segurança está organizada em seções recolhíveis de Perfil, Autenticação, Registro e Endereço IP confiável. Configure os campos em cada seção conforme descrito abaixo e clique em Salvar para salvar e fechar a configuração ou Cancelar para fechá-la sem salvar.

Perfil

• Nome do perfil: Digite um nome para identificar o perfil de segurança. O nome não pode começar ou terminar com um espaço. É permitido um máximo de 50 caracteres.

  Cuidado

  Se você configurar o perfil de segurança com OAuth 2.0 e usar Microsoft Entra ID ou Google como provedor de identidade OAuth 2.0 (configurado abaixo), o Nome do perfil não deve conter espaços. Se o Nome do perfil contiver espaços, você receberá um erro ao tentar acessar uma API à qual o perfil de segurança está atribuído.

• Ambiente: Use o menu suspenso para selecionar um ambiente existente onde o perfil de segurança pode ser atribuído. Você pode digitar qualquer parte do nome do ambiente no menu para filtrar a lista de ambientes. Os resultados do menu são filtrados em tempo real a cada digitação. Para saber mais sobre a relação entre ambientes e perfis de segurança, consulte Múltiplos perfis de segurança em Conceitos-chave.

• Padrão: Selecione para tornar este perfil de segurança o padrão para o ambiente selecionado. O perfil de segurança padrão será pré-selecionado quando uma nova API for criada. Apenas um perfil de segurança padrão pode ser selecionado em cada ambiente. Depois que um perfil de segurança padrão tiver sido especificado para um ambiente, selecionar um perfil de segurança diferente como padrão substituirá a seleção de perfil de segurança padrão existente. Selecionar ou alterar o perfil de segurança padrão não afetará o perfil de segurança atribuído às APIs existentes.

• Descrição: Digite uma descrição opcional do perfil de segurança.

• Limites de taxa e ocorrências por minuto: Ative Limites de taxa para impor um número máximo compartilhado de ocorrências de API por minuto que podem ser feitas em todas as APIs às quais este perfil de segurança está atribuído. Quando esta opção é selecionada, você deve inserir um número máximo de ocorrências por minuto.

  Quando ativado, as chamadas acima do máximo definido são rejeitadas. Dessa forma, as chamadas para APIs atribuídas a este perfil de segurança podem sofrer um número aumentado de rejeições. Para mais informações, consulte Limites de taxa em Conceitos-chave.

Autenticação

Use o menu Tipo de autenticação para selecionar um tipo de autenticação para o perfil de segurança. Depois de selecionar o tipo, campos adicionais ficam disponíveis para configuração. Esta seção descreve os campos para cada tipo:

• Anônimo
• Chave de API
• Básico
• OAuth 2.0

Anônimo

Selecione o tipo de autenticação Anônimo se nenhuma autenticação for necessária.

Chave de API

Selecione o tipo de autenticação Chave de API para usar um par de chave e valor de API para acessar uma API atribuída a este perfil de segurança. Quando este tipo é selecionado, estes campos são usados para criar as credenciais necessárias:

• Chave: Digite o nome do cabeçalho que você deseja usar, como Authorization ou X-API-KEY. É permitido um máximo de 256 caracteres.
• Valor: Um valor é gerado automaticamente para uso com o nome do cabeçalho Chave. Você pode editar o valor ou usar o ícone atualizar para gerar um novo valor. É permitido um máximo de 256 caracteres.
• Copiar: Copia o Valor para sua área de transferência.
• Expiração da chave de API e Duração da expiração (dias): Esta alternância está desativada por padrão, caso em que o valor da chave de API nunca expira. Ative Expiração da chave de API para definir um período de expiração para o valor da chave de API. Quando ativado, digite o número de dias após o qual a chave de API expira no campo Duração da expiração (dias). O valor padrão é 180.

Antes de uma chave de API expirar, a Jitterbit envia um email de lembrete aos administradores da sua organização. Após uma chave de API expirar, as solicitações de API que usam essa chave são rejeitadas com um erro HTTP 401 Unauthorized.

Básico

Selecione o tipo de autenticação Básico para usar autenticação HTTP básica e acessar uma API atribuída a este perfil de segurança. Quando este tipo é selecionado, estes campos são usados para criar as credenciais necessárias:

• Nome de usuário: Digite um nome de usuário para criar para acessar a API. O nome de usuário diferencia maiúsculas de minúsculas e não deve conter dois-pontos (:) se você pretender usar as credenciais em um cabeçalho HTTP ao chamar a API.

• Senha: Digite uma senha para criar para acessar a API.

Base64Encode("exampleuser"+":"+"examplepassword")

OAuth 2.0

Selecione o tipo de autenticação OAuth 2.0 para usar um token de autorização OAuth 2.0 e acessar uma API atribuída a este perfil de segurança. OAuth 2.0 é um padrão aberto para delegação de acesso. Quando este tipo é selecionado, estes campos são usados para criar as credenciais necessárias:

• Provedor OAuth: Use o menu suspenso para selecionar um provedor de identidade compatível. Escolha um de Azure AD (Microsoft Entra ID), Google, Okta ou Salesforce.

• Fluxo OAuth de 2 pernas: Por padrão, OAuth de 3 pernas é usado para todos os provedores de identidade. Este processo requer interação manual para autenticar ao acessar uma API atribuída a este perfil de segurança. A opção Fluxo OAuth de 2 pernas está disponível apenas para Microsoft Entra ID (Microsoft Entra ID) e Okta. Esta opção permite configurar um escopo e um público para remover a etapa manual.

  Nota

  Se você usar um gateway de API privado, deve usar a versão 10.48 do gateway ou posterior para que esta opção funcione. Se o gateway não for versão 10.48 ou posterior, OAuth de 3 pernas é usado mesmo se OAuth de 2 pernas estiver configurado. Se você não estiver usando um gateway de API privado, esta opção não tem requisitos de versão.

• Domínios autorizados: Digite nomes de domínio separados por vírgulas para limitar o acesso a domínios na lista de permissões. Deixe em branco para acesso irrestrito.

• Credenciais do cliente: Adicione pares de credenciais do cliente (um ID do cliente e um segredo do cliente) para o perfil de segurança para que os consumidores possam se autenticar na API. Quando Fluxo OAuth de 2 pernas está ativado, você pode adicionar várias credenciais do cliente, permitindo que consumidores distintos se autentiquem na mesma API usando credenciais exclusivas. Quando Fluxo OAuth de 2 pernas está desativado (3 pernas), você pode adicionar uma única credencial do cliente. Os seguintes controles estão disponíveis:

  • Pesquisar: Digite qualquer parte de um nome de consumidor para filtrar a lista de credenciais do cliente.

  • Adicionar credencial do cliente: Clique para adicionar uma linha editável à tabela. Preencha estes campos (todos são obrigatórios) e clique na marca de seleção na coluna Ações para salvar a credencial ou no ícone de fechamento para descartá-la:

• Nome do Consumidor: Digite um nome para identificar o consumidor que usa este par de credenciais.

  -   **ID do Cliente:** Digite o ID do cliente que você obteve do provedor de identidade.
  
  -   **Segredo do Cliente:** Digite o segredo do cliente que você obteve do provedor de identidade. Use o ícone <span class="icon-eye-filled"></span> para revelar o valor.
  
  -   **Status:** Defina a credencial como **Ativa** ou **Inativa**. Apenas credenciais **Ativas** podem ser usadas para autenticar com a API.
  

  Cada credencial de cliente salva aparece como uma linha na tabela, exibindo seu Nome do Consumidor, ID do Cliente, Segredo do Cliente e Status. Passe o mouse sobre uma linha para revelar estas ações na coluna Ações:

  • Editar: Clique para editar a credencial do cliente em uma linha editável.

  • Excluir: Clique para excluir a credencial do cliente.

  Consulte as instruções para obter o ID do cliente e o segredo do cliente para Microsoft Entra ID, Google, Okta ou Salesforce.

• Os campos OAuth 2.0 restantes (URL de redirecionamento OAuth, Escopo OAuth, URL de descoberta OpenID, Audience, URL de autorização OAuth, URL de token OAuth, URL de informações do usuário e Adicionar esta URL de redirecionamento à sua conta OAuth) vêm preenchidos com valores padrão e contêm configurações específicas do seu provedor de identidade. Alguns desses campos aparecem apenas quando o Fluxo OAuth de 2 Etapas está ativado. Configure-os de acordo com as instruções do seu provedor de identidade: Microsoft Entra ID (2 etapas, 3 etapas), Google, Okta (2 etapas, 3 etapas) ou Salesforce.

• Testar conectividade: Clique para verificar a conectividade com o provedor de identidade usando a configuração fornecida. O comportamento resultante depende se a opção Fluxo OAuth de 2 Etapas está sendo usada:

  • OAuth de 2 etapas: Para Microsoft Entra ID e Okta quando o Fluxo OAuth de 2 Etapas está sendo usado, o gateway de API obtém o token de acesso e a autenticação acontece automaticamente. Você é então redirecionado para o API Manager com uma mensagem que mostra os resultados do teste.

  • OAuth de 3 etapas: Para Google e Salesforce, e para Microsoft Entra ID e Okta quando o Fluxo OAuth de 2 Etapas não está sendo usado, uma nova aba do navegador exibe a interface de login nativa do provedor de identidade. Depois de fornecer suas credenciais para o provedor de identidade, você é redirecionado para o API Manager com uma mensagem que mostra os resultados do teste.

Registro

Selecione o identificador que será incluído nos cabeçalhos de solicitação da API para rastrear qual método de autorização foi usado para acessar este perfil de segurança. Este valor aparece no campo Usuário definido como nos logs da API para cada solicitação de API, permitindo que você monitore e audite diferentes métodos de acesso.

O rótulo do primeiro botão de opção corresponde ao Tipo de autenticação configurado para o perfil de segurança:

• Anônimo: Envia o valor Anonymous.

• Básico: Envia o valor do campo Username (conforme definido em Autenticação básica).

• OAuth: Envia o valor OAuth2.0.

• API Key: Envia o valor APIKEY.

Quando Custom é selecionado para Logging, este campo fica disponível:

• Request header field: Envia o valor inserido na caixa de texto, por exemplo, X-API-Key.

Endereço IP confiável

Você pode selecionar se deseja limitar o acesso às APIs dentro do perfil de segurança a consumidores de um único endereço IP ou de um intervalo de endereços IP:

• Trust requests only from the following IP ranges: Ative para limitar o acesso às APIs dentro de um perfil de segurança a consumidores de determinados endereços IP. Apenas endereços IP incluídos nos intervalos especificados podem acessar as APIs usando este perfil de segurança. Quando ativado, uma tabela de grupos de IP confiáveis existentes é exibida:

  

  • Search: Digite o nome de um grupo de IP confiável existente. Ao clicar na caixa de pesquisa, uma lista de grupos de IP confiáveis existentes é preenchida. A lista é filtrada em tempo real a cada digitação na caixa de pesquisa. Clique no nome do grupo de IP confiável para adicioná-lo ao perfil de segurança.

  • Assign: Ative para atribuir o grupo de IP confiável ao perfil de segurança.

  • Name: O nome do grupo de IP confiável.

  • Used in: Os nomes dos perfis de segurança onde o grupo de IP confiável está sendo usado atualmente.

  • Actions: Passe o mouse sobre uma linha de grupo de IP confiável para revelar uma ação adicional:

    • Edit: Clique para editar os intervalos de IP para a linha do grupo de IP confiável.

  • New trusted IP group: Clique para adicionar um novo grupo de IP confiável. Ao clicar, esta tela de configuração é exibida:

    

    • Name: Digite um nome para identificar o grupo de IP confiável. Para grupos de IP confiáveis existentes, clique no nome de um grupo de IP confiável para renomeá-lo.

    • New range: Clique para adicionar um intervalo de endereços IP.

    • Start IP Address: Digite o primeiro endereço IP a incluir no intervalo. Apenas endereços IP inseridos em formato IPv4 são suportados.

    • End IP Address: Digite o último endereço IP a incluir no intervalo. Apenas endereços IP inseridos em formato IPv4 são suportados.

    • Description: Digite uma descrição do intervalo de endereços IP (opcional).

    • Actions: Passe o mouse sobre um intervalo de endereços IP para revelar uma ação adicional:

      • Delete: Exclui a linha de intervalo de endereços IP do perfil de segurança.

    • Cancel: Clique para descartar o grupo de IP confiável e retornar à configuração do perfil de segurança.

    • Save: Clique para salvar o grupo de IP confiável. Após o perfil de segurança ser salvo, este grupo de IP confiável estará disponível para uso em outros perfis de segurança conforme necessário.

Exibir perfis de segurança existentes

A página Security Profiles exibe todos os perfis de segurança existentes na organização Harmony selecionada, agrupados por ambiente. Cada coluna da tabela é descrita abaixo:

• Profile Name: O nome do perfil de segurança. Para alternar a ordem de classificação de cada tabela entre ordem alfabética decrescente e crescente, clique na seta para cima ou para baixo.

• Expiry: Para perfis de segurança que usam o tipo de autenticação de chave de API com expiração de chave de API ativada, a data em que a chave de API expira, junto com um badge de status mostrando Expiring soon quando a chave está dentro de 7 dias da data de expiração. Esta coluna fica em branco para perfis de segurança que não têm a expiração de chave de API ativada.

• Auth Type: O tipo de autenticação usado para autenticar e acessar as APIs atribuídas a este perfil de segurança.

• Descrição: Uma descrição do perfil de segurança, se fornecida.

• APIs usando: As APIs às quais o perfil de segurança está atribuído.

• Requisições por minuto: O número máximo de requisições de API permitidas por minuto usando este perfil, se configurado.

• Ambiente: O ambiente onde o perfil de segurança se aplica.

• Classe de ambiente: A classe do ambiente. Esta informação é usada apenas para fins de relatório.

• Padrão: O nome do ambiente padrão do perfil de segurança, se configurado.

• Criado: A data e hora local do navegador quando o perfil de segurança foi criado.

• Criado por: O endereço de email do usuário que criou o perfil de segurança.

• Última edição: A data e hora local do navegador quando o perfil de segurança foi modificado pela última vez.

• Editado por: O endereço de email do usuário que editou o perfil de segurança mais recentemente.

• Grupos de IP confiáveis: Qualquer grupo de IP confiável atribuído ao perfil de segurança. Para mais informações, consulte Endereços IP confiáveis.

• Ações: Passe o mouse sobre um perfil de segurança para revelar estes ícones de ação:

  • Editar: Clique para abrir a tela de configuração do perfil de segurança.

  • Excluir: Clique para excluir permanentemente o perfil de segurança. Uma mensagem solicita que você confirme a exclusão. Se o perfil de segurança estiver atribuído a qualquer API, você deve primeiro desatribuí-lo ou substituí-lo antes de excluir.

    Importante

    Após desatribuir um perfil de segurança de uma API, você deve salvar e publicar a API para que a alteração entre em vigor. Até que a API seja publicada, o perfil de segurança ainda é considerado "em uso" e não pode ser excluído até que todas as APIs que o utilizavam anteriormente sejam publicadas com a configuração atualizada. Isso se aplica mesmo se a API estiver em status de rascunho com o perfil desatribuído.

  • URL de exibição do OAuth: Quando um perfil de segurança OAuth de 2 etapas está configurado, clique para copiar a URL necessária para gerar um token OAuth. Para instruções, consulte Microsoft Entra ID OAuth de 2 etapas ou Okta OAuth de 2 etapas.

Próximas etapas

Para mais informações sobre como atribuir perfis de segurança a uma API, consulte estes recursos:

• Guia Perfis de segurança da API
• APIs personalizadas
• APIs OData
• APIs proxy

Solução de problemas

Para solução de problemas relacionados, consulte o seguinte no guia de solução de problemas do API Manager:

• Microsoft Entra ID OAuth: O nome do perfil de segurança não pode conter espaços

• Microsoft Entra ID OAuth de 2 etapas: erro OAUTH_INVALID_TOKEN_CODE

• A API do Azure AD Graph foi descontinuada

• Provedor de identidade Google ou Salesforce: OAuth de 2 etapas não é suportado

• Microsoft Copilot Studio: Autenticação básica não suportada

• Autenticação básica: Nomes de usuário inesperados aparecem nos logs da API quando vários perfis de segurança são atribuídos

• CORS ativado: requisições OPTIONS são executadas sem autenticação

• Alterações no perfil de segurança levam vários minutos para entrar em vigor

• O perfil de segurança não pode ser excluído enquanto ainda estiver atribuído a uma API publicada