View a markdown version of this page

Segredo do cliente Salesforce - AWS Secrets Manager

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 valores secretos

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" }
Chave do consumidor

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

Segredo do consumidor

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 OAuth do Salesforce External Client App Manager.

baseUri

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

appId

O ID do aplicativo é o identificador do seu aplicativo Salesforce External Client (ECA). Você pode recuperá-lo ligando para 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. https://help.salesforce.com/s/articleView?id=xcloud.eca_stage_oauth_credentials.htm&type=5

ID do consumidor

A ID do consumidor é o identificador do seu consumidor do Salesforce External Client Application (ECA). Você pode recuperar isso ligando para 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. Deve estar no formato em vXX.X que X há um caractere numérico.

administrador SecretArn

(Opcional) O ARN do segredo do administrador é o nome de recurso da Amazon (ARN) do segredo que contém as credenciais administrativas do OAuth que devem ser 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á as credenciais do OAuth dentro desse segredo para se autenticar com o Salesforce.

Fluxo de uso

Com AWS Secrets Manager, você pode alternar um segredo do Salesforce usando as credenciais no mesmo segredo ou usar as credenciais no segredo do administrador para rotação. Você pode criar seu segredo usando a CreateSecret chamada 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 RotateSecret chamada. Essa chamada exige a especificação dos campos de metadados, como no exemplo acima. Se você optar por uma rotação usando credenciais no mesmo segredo, poderá ignorar o campo admin. SecretArn Além disso, os clientes devem fornecer uma função ARN na RotateSecret chamada que conceda ao serviço as permissões necessárias para alternar o segredo. Para ver um exemplo de política de permissões, consulte Segurança e permissões.

Para alternar seus segredos usando um conjunto separado de credenciais armazenadas em um segredo do administrador, crie o segredo do administrador AWS Secrets Manager seguindo as mesmas etapas do segredo do consumidor. Você deve fornecer o ARN desse segredo administrativo nos metadados de rotação em uma RotateSecret chamada para obter seu segredo de consumidor.

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