Este artigo lista as APIs REST de autenticação e gerenciamento de senhas com suporte para consoles de gerenciamento locais do Microsoft Defender for IoT.
set_password (Alterar palavra-passe)
Use essa API para permitir que os usuários alterem suas próprias senhas. Todas as funções de usuário do Defender for IoT podem trabalhar com a API.
Você não precisa de um token de acesso do Defender for IoT para usar essa API.
URI: /external/authentication/set_password
PUBLICAR
Tipo: JSON
Exemplo:
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
Parâmetros de solicitação
|
Nome |
Tipo |
Obrigatório / Opcional |
|
nome de utilizador |
String |
Necessário |
|
palavra-passe |
String |
Necessário |
|
new_password |
String |
Necessário |
Tipo: JSON
| Mensagem |
Descrição |
|
Sucesso – msg |
A palavra-passe foi substituída |
|
Falha – erro |
Falha de autenticação do usuário |
|
Falha – erro |
A palavra-passe não corresponde à política de segurança |
Exemplo de resposta
response:
{
"error": {
"userDisplayErrorMessage": "User authentication failure"
}
}
Tipo: POST
API:
curl -k -d '{"username": "<USER_NAME>","password": "<CURRENT_PASSWORD>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json' https://<IP_ADDRESS>/external/authentication/set_password
Exemplo:
curl -k -d '{"username": "myUser","password": "1234@abcd","new_password": "abcd@1234"}' -H 'Content-Type: application/json' https://127.0.0.1/external/authentication/set_password
set_password_by_admin (Atualização de senha de usuário pelo administrador do sistema)
Use essa API para permitir que os administradores do sistema alterem senhas para usuários especificados. As funções de usuário administrador do Defender for IoT podem trabalhar com a API.
Você não precisa de um token de acesso do Defender for IoT para usar essa API.
URI: /external/authentication/set_password_by_admin
PUBLICAR
Tipo: JSON
Exemplo de solicitação
request:
{
"admin_username": "admin",
"admin_password: "Test0987"
"username": "test",
"new_password": "Test54321\!"
}
Parâmetros de solicitação
|
Nome |
Tipo |
Obrigatório / Opcional |
|
admin_username |
String |
Necessário |
|
admin_password |
String |
Necessário |
|
nome de utilizador |
String |
Necessário |
|
new_password |
String |
Necessário |
Tipo: JSON
Cadeia de caracteres de mensagem com os detalhes do status da operação:
| Mensagem |
Descrição |
|
Sucesso – msg |
A palavra-passe foi substituída |
|
Falha – erro |
Falha de autenticação do usuário |
|
Falha – erro |
O usuário não existe |
|
Falha – erro |
A palavra-passe não corresponde à política de segurança |
|
Falha – erro |
O usuário não tem as permissões para alterar a senha |
Exemplo de resposta
response:
{
"error": {
"userDisplayErrorMessage": "The user 'test_user' doesn't exist",
"internalSystemErrorMessage": "The user 'yoavfe' doesn't exist"
}
}
Campos do dispositivo
|
Nome |
Tipo |
Obrigatório / Opcional |
|
admin_username |
String |
Necessário |
|
admin_password |
String |
Necessário |
|
nome de utilizador |
String |
Necessário |
|
new_password |
String |
Necessário |
Tipo: POST
API:
curl -k -d '{"admin_username":"<ADMIN_USERNAME>","admin_password":"<ADMIN_PASSWORD>","username": "<USER_NAME>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json' https://<IP_ADDRESS>/external/authentication/set_password_by_admin
Exemplo:
curl -k -d '{"admin_user":"adminUser","admin_password": "1234@abcd","username": "myUser","new_password": "abcd@1234"}' -H 'Content-Type: application/json' https://127.0.0.1/external/authentication/set_password_by_admin
validação (Autenticar credenciais de usuário)
Use esta API para validar as credenciais do usuário.
Você não precisa de um token de acesso do Defender for IoT para usar essa API.
URI: /external/authentication/validation
PUBLICAR
Tipo: JSON
Parâmetros de consulta
|
Nome |
Tipo |
Obrigatório/Opcional |
|
nome de utilizador |
String |
Necessário |
|
palavra-passe |
String |
Necessário |
Exemplo de solicitação
request:
{
"username": "test",
"password": "Test12345\!"
}
Tipo: JSON
Cadeia de caracteres de mensagem com os detalhes do status da operação:
| Mensagem |
Descrição |
|
Sucesso - msg |
Autenticação bem-sucedida |
|
Falha - erro |
Falha na validação de credenciais |
Exemplo de resposta
response:
{
"msg": "Authentication succeeded."
}
Tipo: POST
API:
curl -k -X POST -H "Authorization: <AUTH_TOKEN>" -H "Content-Type: application/json" -d '{"username": <USER NAME>, "password": <PASSWORD>}' https://<IP_ADDRESS>/external/authentication/validation
Exemplo:
curl -k -X POST -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" -H "Content-Type: application/json" -d '{"username": "test", "password": "test"}' https://127.0.0.1/external/authentication/validation
Próximos passos
Para obter mais informações, consulte a visão geral de referência da API do Defender for IoT.