Segredo do cliente Salesforce - AWS Secrets Manager
Campos de valor secretoCampos de metadados secretosFluxo de uso

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Segredo do cliente Salesforce

Campos de valor secreto

A seguir estão os campos que devem estar contidos no segredo do Secrets Manager:

{
  "consumerKey": "client ID", 
  "consumerSecret": "client secret", 
  "baseUri": "https://domain.my.salesforce.com", 
  "appId": "app ID", 
  "consumerId": "consumer ID"
}
consumerKey

A chave do consumidor, também conhecida como ID do cliente, é o identificador de credencial para as credenciais OAuth 2.0. Você pode recuperar a chave do consumidor diretamente das configurações do Salesforce External Client App Manager. OAuth

consumerSecret

O segredo do consumidor, também conhecido como segredo do cliente, é a senha privada usada com a chave do consumidor para autenticar usando o fluxo de credenciais do cliente OAuth 2.0. Você pode recuperar o segredo do consumidor diretamente das configurações do Salesforce External Client App Manager. OAuth

baseUri

O URI base é o URL base da sua organização do Salesforce usado para interagir com o Salesforce. APIs Isso assume a forma do seguinte exemplo:https://domainName.my.salesforce.com.

appId

O ID do aplicativo é o identificador do seu aplicativo cliente externo Salesforce (ECA). Você pode recuperar isso chamando o endpoint de uso do Salesforce. OAuth Ele deve começar com 0x e conter somente caracteres alfanuméricos. Esse campo se refere ao external_client_app_identifier no guia de rotação do Salesforce.

ID do consumidor

O ID do consumidor é o identificador do seu consumidor do Salesforce External Client Application (ECA). Você pode recuperar isso chamando o endpoint Salesforce OAuth Credentials by App ID. Esse campo se refere ao consumer_id no guia de rotação do Salesforce.

Campos de metadados secretos

A seguir estão os campos de metadados necessários para alternar um segredo mantido pela Salesforce.

{
  "apiVersion": "v65.0",
  "adminSecretArn": "arn:aws:secretsmanager:us-east-1:111122223333:secret:SalesforceClientSecret"
}
apiVersion

A versão da API do Salesforce é a versão da API da sua organização do Salesforce. A versão deve ser pelo menos v65.0. Ele deve estar no formato em vXX.X que X há um caractere numérico.

adminSecretArn

(Opcional) O ARN do segredo do administrador é o Amazon Resource Name (ARN) do segredo que contém as OAuth credenciais administrativas que serão usadas para alternar esse segredo do cliente Salesforce. No mínimo, o segredo do administrador deve conter um valor ConsumerKey e ConsumerSecret dentro da estrutura secreta. É um campo opcional e, se omitido, durante a rotação, o Secrets Manager usará OAuth as credenciais desse segredo para se autenticar no Salesforce.

Fluxo de uso

Os clientes que armazenam segredos do Salesforce AWS Secrets Manager têm a opção de alternar um segredo com as credenciais armazenadas no mesmo segredo ou usar as credenciais no segredo do administrador para rotação. Você pode criar seu segredo usando a CreateSecretchamada com o valor secreto contendo os campos mencionados acima e o tipo de segredo como SalesforceClientSecret. As configurações de rotação podem ser definidas usando uma RotateSecretchamada. Essa chamada requer a especificação dos campos de metadados, como no exemplo acima. Se você optar por uma rotação usando credenciais no mesmo segredo, poderá pular o campo. adminSecretArn Além disso, os clientes devem fornecer um ARN de função na RotateSecretchamada que conceda ao serviço as permissões necessárias para alternar o segredo. Para obter um exemplo de política de permissões, consulte Segurança e permissões.

Para clientes que optam por alternar seus segredos usando um conjunto separado de credenciais (armazenado em um segredo administrativo), certifique-se de criar o segredo administrativo AWS Secrets Manager seguindo exatamente as mesmas etapas do segredo do consumidor. Você deve fornecer o ARN desse segredo administrativo nos metadados de rotação em uma RotateSecretchamada para seu segredo de consumidor.

A lógica de rotação segue a orientação fornecida pela Salesforce.