Habilitar configurações de OAuth para integração à API
Você pode usar um aplicativo conectado para solicitar acesso a dados do Salesforce em nome de um aplicativo externo. Para um aplicativo conectado solicitar acesso, ele deve ser integrado à API do Salesforce usando o protocolo OAuth 2.0. OAuth 2.0 é um protocolo aberto que autoriza o compartilhamento de dados seguro entre aplicativos por meio da troca de tokens. Quando desenvolvedores ou fornecedores de software independentes (ISV) querem integrar o aplicativo ao Salesforce, eles usam APIs OAuth. Essas APIs do OAuth possibilitam que um usuário trabalhe em um aplicativo, mas veja os dados de outro.
Edições obrigatórias
| Disponível em: Salesforce Classic e Lightning Experience |
Aplicativos conectados podem ser criados nas: Group, Essentials, Professional, Enterprise, Performance, Unlimited e Developer Editions Aplicativos conectados podem ser instalados em: Todas as edições |
| Permissões necessárias ao usuário | |
|---|---|
| Para ler, criar, atualizar ou excluir aplicativos conectados: | Personalizar aplicativo E também Modificar todos os dados OU Gerenciar aplicativos conectados |
| Para atualizar todos os campos, com exceção de Perfis, Conjuntos de permissões e Atributos de SAML do provedor de serviços: | Personalizar aplicativo E também Modificar todos os dados OU Gerenciar aplicativos conectados |
| Para atualizar Perfis, Conjuntos de permissões e Atributos de SAML do provedor de serviços: | Personalizar aplicativo E Modificar todos os dados E Gerenciar perfis e Conjuntos de permissões |
| Para girar a chave de consumidor e o segredo do consumidor: | Permitir rotação de chave e segredo de consumidor |
| Para instalar e desinstalar aplicativos conectados: | Personalizar aplicativo E também Modificar todos os dados OU Gerenciar aplicativos conectados |
| Para instalar e desinstalar aplicativos conectados empacotados: | Fazer download de pacotes do AppExchange E Personalizar aplicativo E Modificar todos os dados OU Gerenciar aplicativos conectados |
Veja Nossos aplicativos conectados não podem mais ser criados na versão Spring '26 para obter mais detalhes.
- Crie seu aplicativo conectado e preencha suas informações básicas.
- Na área de API (Habilitar configurações de OAuth) da página, selecione Habilitar configurações de OAuth.
-
Se você estiver configurando um aplicativo conectado para um aplicativo externo em um dispositivo com entrada ou recursos de exibição limitados, como TVs, aparelhos ou aplicativos de linha de comando, selecione Ativar para fluxo do dispositivo.
Um URL de retorno não é usado no fluxo do dispositivo. Porém, quando esse fluxo for ativado, o valor do URL de retorno usará um espaço reservado como padrão. É possível especificar um URL de retorno conforme necessário, como quando esse mesmo cliente está sendo usado para um fluxo diferente.
-
Digite o URL de retorno (ponto final) que o Salesforce usa para fazer uma chamada de retorno ao seu aplicativo durante a autenticação OAuth. É o mesmo URI de redirecionamento do OAuth.
Dependendo do fluxo OAuth usado, geralmente o URL é aquele para o qual o navegador do usuário é redirecionado depois de uma autorização bem-sucedida.Visto que esse URL é usado para que alguns fluxos OAuth passem um token de acesso, ele deve usar HTTPS seguro ou um esquema de URI personalizado.Se você inserir vários URLs de retorno, no tempo de execução, o Salesforce tentará encontrar uma correspondência do valor do URL de retorno especificado pelo aplicativo com um dos valores em URL de retorno. Ele deve corresponder a um dos valores para passar na validação. Separe vários URLs de retorno com quebras de linha. O campo URL de retorno possui um limite de 2.000 caracteres, cumulativamente. Se você inserir vários URLs e eles excederem esse limite, crie outro aplicativo conectado para gerenciar mais URLs de retorno.
-
Se estiver usando o fluxo de OAuth JWT, selecione Usar assinaturas digitais. Se o aplicativo usar um certificado, clique em Escolher arquivo e selecione o certificado em seu sistema para carregar para o fluxo de OAuth do JWT.
Importante O certificado é limitado a 4 mil caracteres e o arquivo deve ter menos de 4 KB. - Selecione os escopos de OAuth a serem aplicados ao aplicativo conectado. Os escopos de OAuth definem permissões para o aplicativo conectado, que são concedidas como tokens depois da autorização do aplicativo. O nome do token de OAuth aparece entre parênteses. Para obter uma lista de escopos e suas descrições, consulte Tokens e escopos de OAuth.
-
Para exigir a extensão de Chave de comprovação para Code Exchange (PKCE) OAuth 2.0 para todas as versões com suporte do fluxo de código de autorização OAuth 2.0, selecione Exigir a extensão Chave de comprovação para Code Exchange (PKCE) para fluxos de autorização com suporte.
Essa configuração exige a PKCE para o fluxo de servidor da Web, o fluxo de servidor da Web híbrido, o Fluxo de credenciais e código de autorização e todas as variações do Fluxo de credenciais e código de autorização, incluindo registro autônomo, login sem senha e identidade autônoma para usuários convidados. Com essa configuração habilitada, qualquer um desses fluxos que não implemente a PKCE será bloqueado para esse aplicativo conectado. Para obter mais informações sobre como usar a PKCE para proteger seus aplicativos, consulte Extensão de Chave de prova para troca de código (PKCE).
-
Para exigir o segredo do cliente do aplicativo em troca de um token de acesso, selecione Exigir segredo para o Fluxo de servidor da Web.
Importante Se o aplicativo cliente não conseguir manter a confidencialidade do segredo do cliente e precisar usar o fluxo do servidor da Web, desmarque a opção Exigir segredo para o fluxo do servidor da Web. Ainda geramos um segredo de cliente para seu aplicativo, mas essa configuração instrui que o fluxo do servidor da Web não exija o parâmetro client_secret na solicitação de token de acesso. Recomendamos o agente de usuário como uma opção mais segura do que o fluxo de servidor da Web sem o segredo. -
Para exigir o segredo do cliente na solicitação de autorização de um token de atualização e fluxo do token de atualização híbrido, selecione Exigir segredo para o fluxo de token de atualização. Se você não selecionar essa opção, e um aplicativo enviar o segredo do cliente na solicitação de autorização, o Salesforce ainda assim fará a validação.
Você pode selecionar essa opção para aplicativos baseados no servidor da Web que podem proteger segredos dos clientes. Porém, para aplicativos que não podem proteger os segredos dos clientes, como aplicativos móveis ou aplicativos instalados no computador do usuário, não recomendamos a seleção dessa opção.
Nota Para novos aplicativos conectados, essa seleção é habilitada automaticamente. Para aplicativos conectados criados antes da versão Spring '21, essa seleção não é habilitada automaticamente. - Para definir as configurações para o fluxo de credenciais do cliente, consulte Configurar um aplicativo conectado para o fluxo de credenciais do cliente do OAuth 2.0.
- Para definir as configurações para o fluxo de código e credenciais de autorização, consulte Configurar um aplicativo conectado para o fluxo de código e credenciais de autorização.
- Para definir as configurações para o fluxo de troca de token, consulte Integrar um aplicativo para o fluxo de troca de token.
-
Para obter um novo token de atualização sempre que o fluxo do token de atualização for invocado, selecione Habilitar rotação de token de atualização.
Habilitar essa configuração é uma prática recomendada de segurança. Com essa configuração habilitada, o token de atualização antigo é invalidado automaticamente depois de ser usado, de modo que cada token seja usado apenas uma vez. Se alguém tentar usar um token de atualização que foi rotacionado, o Salesforce invalidará o token de atualização atual e todos os tokens de acesso associados.
- Para configurar os tokens de acesso baseados em Token Web JSON (JWT), consulte Habilitar tokens de acesso baseados em Token Web JSON (JWT).
-
Para autorizar que um aplicativo conectado único verifique internamente todo o acesso e atualize tokens dentro de toda a organização, selecione Verificar internamente todos os tokens.
Por padrão, todos os aplicativos conectados podem verificar internamente seus próprios tokens. Além disso, um cliente OAuth que registra os aplicativos conectados filhos de OAuth 2.0 por meio do ponto de extremidade de registro de cliente dinâmico poderá verificar os tokens para si mesmo e seus aplicativos registrados. Consulte Verificação interna de token OpenID Connect.
-
Para controlar como a solicitação de OAuth trata o token de ID, selecione Configurar token de ID.
Se a solicitação de OAuth incluir o escopo Permitir acesso ao seu identificador único (openid), o token retornado poderá incluir o token de ID.
O token de ID sempre é incluído nas respostas de token de acesso.
Com a configuração principal de token de ID ativada, defina as configurações secundárias, que controlam o conteúdo do token de ID nas respostas de token de acesso e atualização. Especifique essas configurações.
Configuração Descrição Token válido por O período de tempo durante o qual o token de ID será valido após a emissão. O período pode ser de 1 a 720 minutos. O padrão são 2 minutos. Públicos do token de ID Os consumidores aos quais o token de ID se destina. Por exemplo, o serviço de destino em que você usa o token de ID, como https://your_service.com. Incluir declarações padrão Inclua as declarações padrão contendo informações sobre o usuário, como o nome, o perfil, o número de telefone e o endereço do usuário. As especificações OpenID Connect definem um conjunto de declarações padrão a ser retornado no token do ID. Incluir atributos personalizados Se o seu aplicativo tiver atributos personalizados especificados, inclua-os no token de ID. Incluir permissões personalizadas Se o seu aplicativo tiver permissões personalizadas especificadas, inclua-as no token de ID. -
Se você estiver configurando o aplicativo para emitir tokens de ativo para dispositivos conectados, selecione Habilitar tokens de ativo e especifique estas configurações.
Configuração Descrição Token válido por A duração de tempo em que o token de ativo é válido após sua emissão. Certificado de assinatura do ativo O certificado autoassinado que você criou para assinar tokens de ativo. O tamanho do certificado não pode exceder 4 KB. Públicos-alvo de ativo Os consumidores pretendidos do token do ativo. Por exemplo, o serviço de back-end para o dispositivo conectado, como https://backend_do_seu_dispositivo.com. Incluir atributos personalizados Se seu aplicativo tiver atributos personalizados especificados, inclua-os no token de ativo. Incluir permissões personalizadas Se seu aplicativo tiver permissões personalizadas especificadas, inclua-as no token de ativo. Especifique o URL de retorno (ponto final). Por exemplo, https://backend_do_seu_dispositivo.com/callback.
Selecione os escopos do OAuth Acessar e gerenciar seus dados (api) e Permitir acesso a seu identificador exclusivo (openid), que são obrigatórios para tokens de ativo.
-
Para usar logout único para casos de uso em que o Salesforce é um provedor do OpenID Connect, selecione Habilitar logout único e insira um URL de logout único para determinar para onde o Salesforce envia solicitações de logout. O URL de logout único deve ser um URL absoluto começando com https://.
Essas configurações são apenas uma parte de uma única configuração de logout. Para concluir a configuração de logout único, defina o URL para o qual os usuários serão redirecionados depois de fazerem logout e compartilharem informações com seu provedor do OpenID Connect. Consulte Configurar logout único do OpenID Connect com o Salesforce como provedor do OpenID Connect.
- Após definir todas as configurações para seu aplicativo conectado, salve suas alterações.
Para obter ajuda sobre a configuração de fluxos OAuth, consulte Fluxos de autorização OAuth na Ajuda do Salesforce.

