Consulte os conetores suportados para a solução Application Integration.
Gerir perfis de autenticação
As tarefas na sua integração de aplicações podem exigir uma ligação a uma aplicação externa, um serviço ou uma origem de dados. Um perfil de autenticação permite-lhe configurar e armazenar os detalhes de autenticação da ligação na integração de aplicações. Pode configurar a tarefa para usar o perfil de autenticação armazenado. A criação de um perfil de autenticação é uma atividade única e pode reutilizar o mesmo perfil em várias integrações.
Funções necessárias
Para receber as autorizações de que precisa para gerir perfis de autenticação, peça ao seu administrador que lhe conceda as seguintes funções de IAM numa integração:
-
Administrador de integração de aplicações (
roles/integrations.integrationAdmin
) -
Crie perfis de autenticação:
Editor de integração de aplicações (
roles/integrations.integrationEditor
) -
Editar perfis de autenticação:
Editor de integração de aplicações (
roles/integrations.integrationEditor
) -
Elimine perfis de autenticação:
Administrador da integração de aplicações (
roles/integrations.integrationAdmin
)
Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.
Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.
Crie um ID de cliente OAuth 2.0
Um ID de cliente é usado para identificar uma única aplicação nos servidores OAuth da Google. Se a sua aplicação for executada em várias plataformas, cada uma precisa do seu próprio ID de cliente. Para usar o OAuth 2.0 na sua aplicação, precisa de um ID de cliente OAuth 2.0, que a sua aplicação usa quando pede uma chave de acesso OAuth 2.0.
Para criar um ID de cliente OAuth 2.0, siga estes passos:
- Na Google Cloud consola, aceda a APIs e serviços > Credenciais.
- Clique em + Criar credenciais e selecione ID de cliente OAuth na lista de opções disponíveis.
É apresentada a página Criar ID de cliente OAuth.
- Tipo de aplicação: selecione Aplicação Web na lista pendente.
- Nome: introduza um nome para o seu cliente OAuth 2.0 para identificar o cliente na Cloud Console.
- Em URIs de redirecionamento autorizados, clique em +Adicionar URI e introduza o seguinte:
https://console.cloud.google.com/integrations/callback/locations/AUTH_PROFILE_REGION
- Clique em Criar.
Um ID de cliente OAuth 2.0 é criado com êxito.
Crie um novo perfil de autenticação
Para criar um novo perfil de autenticação, selecione uma das seguintes opções:
Consola
- Na Google Cloud consola, aceda à página Application Integration.
- No menu de navegação, clique em Perfis de autorização.
- Clique em Criar e introduza os seguintes detalhes:
- No campo Nome do perfil, introduza o nome do perfil de autenticação a apresentar no editor de integração.
- Na lista Região, selecione uma região para o perfil de autenticação.
- No campo Descrição, introduza uma descrição para o perfil de autenticação.
- Clique em Continuar.
- Na lista Tipo de autenticação, selecione o tipo de autenticação e introduza os detalhes necessários. Com base na sua seleção, a caixa de diálogo apresenta campos adicionais necessários para as credenciais de autenticação. Pode selecionar qualquer um dos seguintes tipos de autenticação:
- Opcionalmente, pode adicionar certificados de cliente SSL/TLS que são usados pelo servidor para validar a identidade de um cliente. Pode introduzir o seguinte campo:
- Certificado SSL
- Chave privada
- Frase de acesso da chave privada
A região que selecionar aqui tem de ser a mesma que a
AUTH_PROFILE_REGION
usada nos URIs de redirecionamento autorizados quando criou o ID de cliente OAuth 2.0. - Clique em Criar.
É apresentada a página Perfis de autenticação.
Terraform
Use o recurso google_integrations_client
.
Pode usar o Terraform para criar os seguintes perfis de autenticação:
- Símbolo de autorização
- Apenas certificação de cliente SSL/TLS
- Símbolo da Web JSON (JWT)
- Código de autorização do OAuth 2.0
- Credenciais de cliente OAuth 2.0
- Token de ID do OIDC
- Conta de serviço
Símbolo de autorização
O exemplo seguinte cria um tipo de autenticação de token de autorização na região us-central1
:
Certificação de cliente SSL/TLS
O exemplo seguinte cria um tipo de autenticação de certificação de cliente SSL/TLS na região us-central1
:
Símbolo da Web JSON (JWT)
O exemplo seguinte cria um tipo de autenticação de símbolo da Web JSON (JWT) na região us-central1
:
Código de autorização do OAuth 2.0
O exemplo seguinte cria um tipo de autenticação de certificação de cliente SSL/TLS na região us-central1
:
Credenciais de cliente OAuth 2.0
O exemplo seguinte cria um tipo de autenticação de credenciais de cliente OAuth 2.0 na região us-central1
:
Token de ID do OIDC da Google
O exemplo seguinte cria um tipo de autenticação de token de ID OIDC da Google na região us-central1
:
resource "random_id" "default" { byte_length = 8 } resource "google_service_account" "service_account" { account_id = "sa-${random_id.default.hex}" display_name = "Service Account" } resource "google_integrations_auth_config" "auth_config_oidc_token" { location = "us-central1" display_name = "tf-oidc-token" description = "Test auth config created via terraform" decrypted_credential { credential_type = "OIDC_TOKEN" oidc_token { service_account_email = google_service_account.service_account.email audience = "https://us-central1-project.cloudfunctions.net/functionA 1234987819200.apps.googleusercontent.com" } } depends_on = [google_service_account.service_account, google_integrations_client.client] }
Conta de serviço
O exemplo seguinte cria um tipo de autenticação de conta de serviço na região us-central1
:
resource "random_id" "default" { byte_length = 8 } resource "google_service_account" "service_account" { account_id = "sa-${random_id.default.hex}" display_name = "Service Account" } resource "google_integrations_auth_config" "auth_config_service_account" { location = "us-central1" display_name = "tf-service-account" description = "Test auth config created via terraform" decrypted_credential { credential_type = "SERVICE_ACCOUNT" service_account_credentials { service_account = google_service_account.service_account.email scope = "https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/adexchange.buyer https://www.googleapis.com/auth/admob.readonly" } } depends_on = [google_service_account.service_account, google_integrations_client.client] }
Depois de guardar, o novo perfil de autenticação fica disponível como uma opção no menu pendente Perfil de autorização a usar de qualquer tarefa que exija autenticação.
Opcional. Se não tiver criado um perfil de autenticação antes de configurar uma tarefa de integração, pode aceder à caixa de diálogo de criação de perfil selecionando + Adicionar novo perfil de autenticação no menu pendente Perfil de autorização a usar no painel de configuração da tarefa. Siga os passos anteriores para criar um novo perfil de autenticação.
Edite perfis de autenticação
Para editar um perfil de autenticação, siga estes passos:
- Na Google Cloud consola, aceda à página Application Integration.
- No menu de navegação, clique em Perfis de autorização.
- Selecione uma Região para o perfil de autenticação através do menu pendente na página Perfis de autenticação.
- Clique em
É apresentada a caixa de diálogo Perfis de autenticação.
(menu Ações) e, de seguida, em Editar.
- Edite os detalhes e clique em Guardar.
É apresentada a página Perfis de autenticação.
Quando edita um perfil de autenticação, tenha em atenção o seguinte:
- Se editar um perfil de autenticação usado por uma tarefa numa integração de rascunho, publique a integração para que as alterações entrem em vigor. Quando testa uma integração de rascunho, esta continua a usar o perfil de autenticação da última versão publicada.
- Se uma tarefa numa integração com um mecanismo de repetição usar um perfil de autenticação, publique a integração depois de atualizar o perfil para garantir que a tarefa usa o perfil atualizado.
Elimine perfis de autenticação
Para eliminar um perfil de autenticação, siga estes passos:
- Na Google Cloud consola, aceda à página Application Integration.
- No menu de navegação, clique em Perfis de autorização.
- Selecione uma Região para o perfil de autenticação através do menu pendente na página Perfis de autenticação.
- Clique em Eliminar.
É apresentada a página Perfis de autenticação.
Tipos de autenticação
O tipo de autenticação necessário para concluir uma tarefa de integração depende da autenticação configurada no servidor de autorização. O servidor de autorização pode ser um servidor autónomo ou uma API que emite credenciais para o cliente de chamada. A integração de aplicações suporta os seguintes tipos de autenticação:
- Símbolo de autorização
- Token de ID OIDC da Google
- Símbolo da Web JSON (JWT)
- Código de autorização do OAuth 2.0
- Credenciais de cliente OAuth 2.0
- Credenciais de palavra-passe do proprietário do recurso OAuth 2.0
- Apenas certificação de cliente SSL/TLS
- Conta de serviço
As secções seguintes descrevem as propriedades de configuração dos tipos de autenticação.
Símbolo de autenticação
O tipo de autenticação Token de autorização usa um token (credenciais) para autenticação. As credenciais são enviadas para o servidor no cabeçalho do pedido HTTP no formatoAuthorization
Authorization: TYPE CREDENTIALS
. Para configurar este tipo de autenticação, defina as seguintes propriedades:
- Tipo: tipo de autenticação, como
Basic
,Bearer
ouMAC
. - Token: credenciais para o tipo de autenticação.
Se o servidor de autenticação exigir um certificado SSL/TLS, carregue o certificado e a chave privada.
Para saber que tarefas suportam este tipo de autenticação, consulte o artigo Compatibilidade dos tipos de autenticação com tarefas.Token de ID OIDC da Google
O tipo de autenticação Google OIDC ID Token usa símbolos da Web JSON (JWT) para autenticação. O fornecedor Google OpenID Connect (OIDC), accounts.google.com, assina e emite estes JWTs para autenticação através de uma conta de serviço. Para configurar este tipo de autenticação, defina as seguintes propriedades:- Conta de serviço: conta de serviço (principal) no seu projeto Google Cloud com autorização para aceder à sua API.
- Público-alvo: o público-alvo do token OIDC (isto identifica os destinatários a quem o JWT se destina). Por exemplo, o URL do acionador é o público-alvo da tarefa Função do Google Cloud.
Símbolo da Web JSON (JWT)
O tipo de autenticação JWT usa o símbolo da Web JSON (JWT) para autenticação. Para mais informações sobre o JWT, consulte o RFC7519. Para configurar este tipo de autenticação, defina as seguintes propriedades:- Cabeçalho JWT: algoritmo usado para gerar a assinatura.
Nota: só pode especificar o algoritmo HS256.
- Payload JWT: um conjunto de reivindicações. Pode usar reivindicações registadas, públicas ou personalizadas.
- Segredo: chave partilhada entre o cliente e o servidor de autenticação.
Se o servidor de autenticação exigir um certificado SSL, carregue o certificado e a chave privada através do selecionador de ficheiros. Introduza a frase de acesso da chave privada .
Para saber que tarefas suportam este tipo de autenticação, consulte o artigo Compatibilidade dos tipos de autenticação com tarefas.Código de autorização OAuth 2.0
O tipo de autenticação código de autorização OAuth 2.0 usa um OAuth 2.0
token de autorização para autenticação. Para configurar este tipo de autenticação, defina as seguintes propriedades:
- Ponto final de autenticação: ponto final do ponto final de autenticação da aplicação. É redirecionado para este URL para rever as autorizações de acesso da aplicação. O token só é gerado depois de o acesso ser concedido.
- Ponto final do token: ponto final que concede ou atualiza o token de acesso.
- ID de cliente: uma string exclusiva fornecida pelo servidor de autenticação ao cliente registado. O ID de cliente não é um segredo e é exposto ao proprietário do recurso. Use este campo juntamente com um segredo do cliente.
- Segredo: chave secreta partilhada entre o cliente (integração) e o servidor de autenticação.
- Âmbitos: âmbito da chave de acesso. Os âmbitos permitem-lhe especificar autorizações de acesso para os utilizadores. Pode especificar vários âmbitos separados por um único espaço (" "). Para mais informações, consulte os âmbitos do OAuth 2.0 para APIs Google.
Se o servidor de autenticação exigir um certificado SSL, carregue o certificado e a chave privada através do selecionador de ficheiros. Introduza a frase de acesso da chave privada no campo disponível, se necessário.
Para saber que tarefas suportam este tipo de autenticação, consulte o artigo Compatibilidade dos tipos de autenticação com tarefas.Credenciais de cliente OAuth 2.0
O tipo de autenticação credenciais do cliente OAuth 2.0 usa um OAuth 2.0
símbolo de autorização para autenticação. Esta autenticação pede primeiro um token de acesso através das credenciais do cliente e, em seguida, usa o token para aceder aos recursos protegidos. Para configurar este tipo de autenticação, defina as seguintes propriedades:
- Ponto final do token: ponto final que concede ou atualiza o token de acesso.
- ID de cliente: uma string exclusiva fornecida pelo servidor de autenticação ao cliente registado. O ID de cliente não é um segredo e é exposto ao proprietário do recurso. Use este campo juntamente com um segredo do cliente.
- Segredo: chave secreta partilhada entre o cliente (integração) e o servidor de autenticação.
- Âmbitos: âmbito da chave de acesso. Os âmbitos permitem-lhe especificar autorizações de acesso para os utilizadores. Pode especificar vários âmbitos separados por um único espaço (" "). Para mais informações, consulte os âmbitos do OAuth 2.0 para APIs Google.
- Tipos de pedidos: mecanismos para enviar os parâmetros do pedido para o servidor de autenticação para obter o token de acesso. Pode especificar qualquer um dos seguintes
tipos de pedidos:
- Cabeçalho do codificador: codifica
CLIENT ID
eCLIENT SECRET
no formatoBase64
e envia a string codificada no cabeçalho de autorização HTTP. Os restantes parâmetros do pedido são enviados no corpo do pedido HTTP. - Parâmetros de consulta: envia os parâmetros do pedido numa string de consulta.
- Corpo do pedido: envia os parâmetros do pedido através do tipo de conteúdo
application/x-www-form-urlencoded
e do conjunto de carateresUTF-8
noentity-body
do pedido HTTP. - Não especificado
- Cabeçalho do codificador: codifica
- Parâmetros do token: parâmetros do pedido necessários para obter o token. Especifique
os valores no formato de chave-valor, em que
Key
é o nome do parâmetro eValue
é o valor do parâmetro correspondente.
Se o servidor de autenticação exigir um certificado SSL, carregue o certificado e a chave privada através do selecionador de ficheiros. Introduza a frase de acesso da chave privada no campo disponível, se necessário.
Para saber que tarefas suportam este tipo de autenticação, consulte o artigo Compatibilidade dos tipos de autenticação com tarefas.Credenciais de palavra-passe do proprietário do recurso OAuth 2.0
O tipo de autenticação credenciais de palavra-passe do proprietário do recurso OAuth 2.0 usa um OAuth 2.0
token de autorização para autenticação. Esta autenticação pede primeiro um token de acesso através das credenciais do proprietário do recurso (nome de utilizador e palavra-passe) e, em seguida, usa o token para aceder aos recursos protegidos. Para configurar este tipo de autenticação, defina as seguintes propriedades com base no tipo de instância ao qual se liga:
- Ponto final do token: ponto final que concede ou atualiza o token de acesso.
- ID de cliente: uma string exclusiva fornecida pelo servidor de autenticação ao cliente registado. O ID de cliente não é um segredo e é exposto ao proprietário do recurso. Use este campo juntamente com um segredo do cliente.
- Segredo: chave secreta partilhada entre o cliente (integração) e o servidor de autenticação.
- Âmbitos: âmbito da chave de acesso. Os âmbitos permitem-lhe especificar autorizações de acesso para os utilizadores. Pode especificar vários âmbitos separados por um único espaço (" "). Para mais informações, consulte os âmbitos do OAuth 2.0 para APIs Google.
- Nome de utilizador: nome de utilizador do proprietário do recurso.
- Palavra-passe: palavra-passe do utilizador.
- Tipos de pedidos: mecanismos para enviar os parâmetros do pedido para o servidor de autenticação para obter o token de acesso. Pode especificar qualquer um dos seguintes
tipos de pedidos:
- Cabeçalho do codificador: codifica
CLIENT ID
eCLIENT SECRET
no formatoBase64
e envia a string codificada no cabeçalho de autorização HTTP. Envia os restantes parâmetros do pedido no corpo do pedido HTTP. - Parâmetros de consulta: envia os parâmetros do pedido numa string de consulta.
- Corpo do pedido: envia os parâmetros do pedido através do tipo de conteúdo
application/x-www-form-urlencoded
e do conjunto de carateresUTF-8
noentity-body
do pedido HTTP.
- Cabeçalho do codificador: codifica
- Parâmetros do token: parâmetros do pedido necessários para obter o token. Especifique
os valores no formato de chave-valor, em que
Key
é o nome do parâmetro eValue
é o valor do parâmetro correspondente.
Se o servidor de autenticação exigir um certificado SSL, carregue o certificado e a chave privada através do selecionador de ficheiros. Introduza a frase de acesso da chave privada no campo disponível, se necessário.
Para saber que tarefas suportam este tipo de autenticação, consulte o artigo Compatibilidade dos tipos de autenticação com tarefas.Apenas certificado de cliente SSL/TLS
O tipo de autenticação apenas certificado de cliente SSL/TLS usa apenas o certificado SSL/TLS para autenticação. Carregue o certificado necessário e a chave privada. Para configurar este tipo de autenticação, carregue os seguintes ficheiros:- Certificado SSL: certificado codificado no formato PEM.
- Chave privada: ficheiro de chave privada do certificado codificado no formato PEM.
Se a chave privada precisar de uma
passphrase
, introduza a frase de acesso da chave privada.
Conta de serviço
O tipo de autenticação Conta de serviço usa as credenciais da conta de serviço de umGoogle Cloud projeto para autenticação. Para configurar este tipo de autenticação, defina as seguintes propriedades:
- Conta de serviço: conta de serviço (principal) no seu projeto do Google Cloud com autorização para aceder à sua API.
- Âmbito(s): âmbito das autorizações de acesso concedidas aos utilizadores. Pode especificar vários âmbitos separados por um único espaço (" "). Para mais informações, consulte Âmbitos do OAuth 2.0 para APIs Google.
Para saber mais sobre as práticas recomendadas para criar e gerir contas de serviço, leia a documentação sobre as práticas recomendadas para trabalhar com contas de serviço.
Se o servidor de autenticação exigir um certificado SSL, carregue o certificado e a chave privada através do selecionador de ficheiros. Introduza a frase de acesso da chave privada no campo disponível, se necessário.
Para saber que tarefas suportam este tipo de autenticação, consulte o artigo Compatibilidade dos tipos de autenticação com tarefas.Compatibilidade dos tipos de autenticação com as tarefas
A tabela seguinte lista os tipos de autenticação e as tarefas compatíveis correspondentes. Pode usar estas informações para decidir que tipo de autenticação usar para uma tarefa.
Regras de autenticação
Se a sua integração tiver um perfil do OAuth 2.0 e uma conta de serviço gerida pelo utilizador configurados, por predefinição, o perfil do OAuth 2.0 é usado para autenticação. Se não estiver configurado nenhum perfil do OAuth 2.0 nem nenhuma conta de serviço gerida pelo utilizador, é usada a conta de serviço predefinida (service-PROJECT_NUMBER@gcp-sa-integrations.iam.gserviceaccount.com
). Se a tarefa não usar a conta de serviço predefinida, a execução falha.