Criar e gerenciar usuários de serviço

Os usuários de serviço são gerenciados no console de administração, ao lado das pessoas da sua organização. Esta página mostra cada passo. Não é preciso programar; os seus desenvolvedores só vão precisar das credenciais que você criar depois.

Antes de começar

Permissões. Você precisa de permissão para gerenciar usuários de serviço na sua organização. Se a aba Usuários de Serviço não aparecer, ou se você não conseguir criar ou editar usuários de serviço, fale com um administrador da sua organização.
Saiba do que a integração precisa. Descubra quais dados a integração lê ou altera. Você vai usar essa informação para escolher o papel com o menor acesso que ainda permita o funcionamento.

Encontrar os usuários de serviço da sua organização

Entre no console de administração.
Na barra lateral, selecione Usuários.
Selecione a aba Usuários de Serviço.

A lista mostra cada usuário de serviço com o seu Papel administrativo, o Status e a data de criação. Você pode buscar pelo nome e filtrar por papel ou status. Selecione uma linha para abrir o usuário de serviço.

Criar um usuário de serviço

Na barra lateral, selecione Usuários e depois Novo Usuário.
Em Tipo de usuário, escolha Usuário de serviço.
Informe um Nome que identifique a integração, por exemplo “Sincronização do RH” ou “Serviço de backup”. Os nomes devem ser únicos na organização.
Escolha um Papel administrativo (veja abaixo).
Selecione Criar usuário de serviço.

O usuário de serviço é criado como Ativo, sem credenciais. Em seguida, crie uma credencial para que a integração consiga se autenticar.

Escolher um papel

Assim como as pessoas, os usuários de serviço têm um papel administrativo que define o que podem fazer na organização. Escolha o papel com o menor acesso que ainda cubra o que a integração faz. Os usuários de serviço podem ter qualquer papel, exceto Proprietário.

Papel	O que permite	Integração típica
Auditor	Acesso somente leitura à organização, incluindo os logs de auditoria.	Relatórios, exportações de conformidade, reagir a webhooks
Provisionador SCIM	Criar, atualizar e remover usuários e grupos e gerenciar os membros dos grupos. Nada além disso.	Plataforma de RH ou diretório que provisiona usuários
Helpdesk	Visualizar usuários e grupos, e cuidar do MFA e das sessões dos usuários gerenciados.	Ferramentas internas de suporte
Faturamento	Gerenciar o faturamento.	Ferramentas financeiras
Administrador	Gerenciar a organização, usuários, grupos, aplicações, faturamento e logs de auditoria.	Apenas quando nada mais restrito funcionar

Para ver exatamente o que cada papel pode fazer, selecione Consultar definições de papéis no formulário.

Dica: se você tem várias integrações, crie um usuário de serviço para cada uma. Assim, cada uma tem apenas o acesso de que precisa e você pode desativar uma sem afetar as outras.

Editar um usuário de serviço

Abra o usuário de serviço a partir da aba Usuários de Serviço.
Selecione Modificar.
Altere o nome, o papel ou o status e selecione Salvar alterações.

Um novo papel vale a partir da próxima requisição do usuário de serviço à API.

Desativar ou reativar um usuário de serviço

Para interromper uma integração imediatamente, desative o usuário de serviço dela:

Abra o usuário de serviço a partir da aba Usuários de Serviço.
Na aba Visão Geral, selecione Alterar status e escolha Inativo.

Enquanto um usuário de serviço estiver Inativo:

ele não consegue obter novos tokens de acesso, seja qual for o estado das suas credenciais;
a API recusa as requisições feitas com os tokens que ele já possui, mesmo que ainda não tenham expirado.

As credenciais dele são mantidas. Quando você voltar o status para Ativo, a integração consegue se autenticar novamente com as suas credenciais ativas, sem nenhuma mudança do lado dela.

Observação: para interromper apenas uma instalação de uma integração, como um ambiente de testes, desative uma das credenciais em vez do usuário de serviço inteiro.

Excluir um usuário de serviço

Abra o usuário de serviço a partir da aba Usuários de Serviço.
Selecione Excluir.
Na janela Excluir usuário de serviço, informe a sua senha atual para confirmar.

Importante: a exclusão de um usuário de serviço não pode ser desfeita. Todas as credenciais dele param de funcionar, e qualquer integração que as use perde o acesso imediatamente. Se você puder precisar dele de novo, desative-o.

As alterações são auditadas

A criação, a atualização e a exclusão de usuários de serviço e das suas credenciais ficam registradas nos Logs de Auditoria da sua organização, assim como cada token de acesso que um usuário de serviço obtém. As ações que um usuário de serviço realiza pela API são registradas com o nome dele.