Credenciais dos usuários de serviço

Uma credencial é o que um usuário de serviço usa para comprovar a sua identidade, assim como uma pessoa usa uma senha. Cada credencial é formada por dois valores:

Valor	Exemplo	O que é
ID do cliente	5f0c3a8e-2b7d-4e91-9a6c-1d2e3f4a5b6c	O identificador público da credencial (client ID). Não é secreto: pode aparecer em logs e configurações.
Client secret	kT9wQ2… (32 caracteres)	A parte confidencial, como uma senha. Quem a possui pode agir como o usuário de serviço. Exibida uma única vez.

A integração troca esses dois valores por um token de acesso de curta duração no endpoint /oauth/token e depois usa o token para chamar a API do BreezeAuth.

Um usuário de serviço pode ter várias credenciais, por exemplo uma por ambiente (produção, homologação) ou por instalação. Cada credencial pode ser desativada, pode expirar e é acompanhada separadamente, o que também permite a rotação sem interrupções.

Criar uma credencial

Guardar o secret com segurança

• Entregue-o à integração por meio de um gerenciador de segredos ou de uma variável de ambiente protegida, nunca no código-fonte.
• Nunca o coloque em uma página web, em um aplicativo móvel ou em qualquer coisa que rode nos dispositivos dos usuários: qualquer pessoa conseguiria extraí-lo.
• Não o envie por e-mail ou chat. Se ele tiver sido exposto, desative a credencial e crie uma nova.

Acompanhar o uso das credenciais

A aba Credenciais lista cada credencial com o seu Status (Ativo ou Inativo), a data de Último uso, a data em que Expira em e a data de criação. O Último uso mostra quando a credencial foi trocada por um token de acesso pela última vez, o que ajuda a identificar credenciais que não são mais usadas e podem ser removidas.

Selecione uma credencial para ver os detalhes. Cada vez que uma credencial é usada para obter um token de acesso, um registro também é criado nos Logs de Auditoria.

Editar uma credencial

O ID do cliente e o client secret em si não podem ser alterados. Para substituir um secret, rotacione a credencial.

Desativar uma credencial

Desative uma credencial quando o secret dela puder ter sido exposto, quando a integração que a usa for desativada ou antes de excluí-la.

A desativação vale imediatamente:

• a credencial não pode mais ser trocada por tokens de acesso;
• todos os tokens de acesso já emitidos com ela param de funcionar já na próxima requisição à API, mesmo que ainda não tenham expirado. O BreezeAuth verifica a credencial a cada requisição, então não existe uma janela em que um token obtido antes continue utilizável.

As outras credenciais do mesmo usuário de serviço continuam funcionando. Você pode reativar a credencial depois, marcando Ativa novamente.

Expiração

Uma credencial com data em Expira em se comporta como uma credencial desativada a partir desse momento: nenhum token novo, e os tokens emitidos antes são recusados. Para estender o prazo, edite a credencial e escolha uma data posterior, ou apague a data.

Rotacionar uma credencial

Rotacionar significa substituir uma credencial por uma nova, por exemplo periodicamente ou quando alguém que conhecia o secret sai da empresa. Como um usuário de serviço pode ter várias credenciais, você pode fazer isso sem interromper a integração:

Excluir uma credencial

Uma credencial precisa ser desativada antes de ser excluída. Enquanto ela estiver ativa, o botão Excluir fica desabilitado com a mensagem “A credencial precisa ser desativada primeiro”.

A exclusão de uma credencial não pode ser desfeita. Desative primeiro, aguarde para confirmar que nada parou de funcionar e depois exclua.