Resumo feito por IA verificado ◀▼
Gerencie tokens OAuth para acesso à API. Essa abordagem garante a autenticação segura da API sem a necessidade de armazenar e usar tokens da API. Crie clientes OAuth para gerar tokens, visualizá-los e apagá-los, quando necessário, bem como editar detalhes dos clientes. Nos planos Enterprise, visualize registros de auditoria para monitorar as atividades do cliente OAuth.
É possível usar tokens de acesso OAuth para autenticar solicitações de API. O OAuth proporciona uma maneira segura para aplicativos acessarem dados do Zendesk sem ter que armazenar e usar tokens da API, que são informações confidenciais.
Não é possível criar tokens de acesso OAuth na Central de administração, como é feito com tokens da API. Primeiro, é preciso criar um cliente OAuth na Central de administração e, em seguida, usar o cliente OAuth em um fluxo de autorização OAuth definido para criar um token de acesso OAuth.
Os tokens de acesso OAuth não são os mesmos que os tokens da API. Consulte a seção sobre diferenças entre tokens da API e tokens de acesso na documentação para desenvolvedores da Zendesk (em inglês).
Este artigo inclui estas seções:
- Criação de clientes OAuth
- Criação de tokens de acesso com um cliente OAuth
- Visualização de tokens de cliente OAuth
- Visualização de escopos para tokens de cliente OAuth
- Exclusão de tokens de cliente OAuth
- Edição de clientes OAuth
- Exclusão de clientes OAuth
- Visualização de registros de auditoria para um cliente OAuth (Enterprise)
Para autenticar solicitações de API com tokens de acesso OAuth, consulte a seção sobre token de acesso OAuth em developer.zendesk.com.
Criação de clientes OAuth
Os clientes OAuth permitem criar tokens de acesso OAuth que podem ser usados para autenticar solicitações de API. Os tokens de acesso OAuth são diferentes dos tokens da API. Os tokens de acesso OAuth proporcionam uma maneira segura para aplicativos acessarem a API do Zendesk sem ter que armazenar e usar os tokens da API dos usuários do Zendesk.
Como criar clientes OAuth
-
Na Central de administração, clique em
Aplicativos e integrações na barra lateral e selecione APIs > Clientes OAuth.
É exibida uma lista de clientes OAuth adicionados à conta pelos administradores.
- Para criar um cliente, clique em Adicionar cliente OAuth e siga as instruções em Registro de seu aplicativo no Zendesk.
Criação de tokens de acesso com um cliente OAuth
Após criar um cliente OAuth na Central de administração, é possível usá-lo com um fluxo de autorização definido para criar tokens de acesso OAuth. Também é possível usar o cliente OAuth com a API para criar tokens de acesso sem um fluxo de autorização. Você pode utilizar um token da API para autenticar essas solicitações da API. Consulte Creating and using OAuth access tokens with the API na documentação para desenvolvedores.
Visualização de tokens de cliente OAuth
Você pode visualizar os tokens de acesso que criou para um cliente OAuth.
Como visualizar tokens de acesso para um cliente OAuth
-
Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > Clientes OAuth.
É exibida uma lista de clientes OAuth. Ela mostra informações do cliente OAuth, incluindo o identificador, o nome, a data de criação, o número de tokens e o status do cliente.
- Encontre o cliente na lista para ver os tokens.
- Clique no ícone do menu de opções (
) ao lado do cliente e selecione Exibir tokens.
É exibida uma lista de tokens de acesso do cliente OAuth.
Clientes sem tokens não verão a opção Exibir tokens.
Visualização de escopos para tokens de cliente OAuth
Os escopos definem se as solicitações autenticadas com o token podem publicar, inserir e apagar dados ou apenas obter dados.
Como visualizar os escopos de um token de cliente OAuth
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > Clientes OAuth.
- Encontre o cliente na lista.
- Clique no ícone do menu de opções () ao lado do cliente e selecione Exibir tokens.
- Encontre o token do qual você quer visualizar os escopos.
- Clique no ícone do menu de opções () ao lado do token e selecione Exibir escopos.
Exclusão de tokens de cliente OAuth
Se você suspeita que um token de cliente OAuth está comprometido, apague-o. Também é possível apagar clientes OAuth que não são mais usados ou que não deveriam estar ativos.
Como apagar um token de cliente OAuth
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > Clientes OAuth.
- Encontre o cliente na lista.
- Clique no ícone do menu de opções () ao lado do cliente e selecione Exibir tokens.
- Encontre o token que você quer apagar.
- Clique no ícone do menu de opções () ao lado do token e selecione Apagar.
Edição de clientes OAuth
Você pode usar a Central de administração para editar seu cliente OAuth. É possível atualizar informações do cliente, como o nome, a descrição, o logotipo, as URLs de redirecionamento e assim por diante.
Como editar um cliente OAuth
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > Clientes OAuth.
- Encontre o cliente na lista.
- Clique no ícone do menu de opções () ao lado do cliente e selecione Editar.
É exibida uma descrição do cliente com campos que você pode editar.
- Faça as alterações necessárias e clique em Salvar.
Exclusão de clientes OAuth
A exclusão de um cliente OAuth desativa todos os tokens de acesso criados com o cliente. A exclusão de um cliente OAuth é permanente. Isso não pode ser desfeito. Quando o cliente é removido, todos os tokens (se houver) associados a ele são revogados imediatamente.
Você também pode apagar tokens de acesso individuais.
Como apagar um cliente OAuth
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > Clientes OAuth.
- Encontre o cliente na lista. Clique no ícone do menu de opções () ao lado do cliente e selecione Apagar.
- Na caixa de diálogo de confirmação, clique em Apagar cliente.
Visualização de registros de auditoria para um cliente OAuth (Enterprise)
Nos planos Enterprise, o registro de auditoria registra a atividade associada aos clientes OAuth, incluindo quando são criados, desativados ou reativados.
Como visualizar registros de auditoria do cliente OAuth
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione APIs > Clientes OAuth.
- Encontre o cliente na lista.
- Clique no ícone do menu de opções () ao lado do cliente e selecione Visualizar registro de auditoria.
O registro de auditoria é aberto com um filtro aplicado para o cliente OAuth selecionado. O registro de auditoria mostra as atividades associadas ao cliente.
