Referência da API de gerenciamento de senha e autenticação para consoles de gerenciamento locais

Este artigo lista as APIs REST de gerenciamento de senha e autenticação com suporte para consoles de gerenciamento local do Microsoft Defender para IoT.

set_password (alterar senha)

Use essa API para permitir que os usuários alterem suas próprias senhas. Todas as funções de usuário do Defender para IoT podem trabalhar com a API.

Você não precisa de um token de acesso do Defender para IoT para usar essa API.

URI: /external/authentication/set_password

POST

Solicitação

Tipo: JSON

Exemplo:

request:
{
    "username": "test",
    "password": "Test12345\!",
    "new_password": "Test54321\!"
}

Parâmetros da solicitação

Nome	Tipo	Obrigatório/Opcional
username	String	Obrigatório
password	String	Obrigatório
new_password	String	Obrigatório

Resposta

Tipo: JSON

Mensagem	Descrição
Sucesso – mensagem	A senha do usuário foi substituída
Falha – erro	Falha na autenticação do usuário
Falha – erro	A senha não atende à política de segurança

Exemplo de resposta

response:

{

    "error": {

        "userDisplayErrorMessage": "User authentication failure"

    }

}

Comando de cURL

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 do usuário pelo administrador do sistema)

Use essa API para permitir que os administradores de sistema alterem senhas para usuários específicos. Todas as funções de usuários de administradores do Defender para IoT podem trabalhar com a API.

Você não precisa de um token de acesso do Defender para IoT para usar essa API.

URI: /external/authentication/set_password_by_admin

POST

Solicitação

Tipo: JSON

Exemplo de solicitação

request:

{
    "admin_username": "admin",
    "admin_password: "Test0987"
    "username": "test",
    "new_password": "Test54321\!"
}

Parâmetros da solicitação

Nome	Tipo	Obrigatório/Opcional
admin_username	String	Obrigatório
admin_password	String	Obrigatório
username	String	Obrigatório
new_password	String	Obrigatório

Resposta

Tipo: JSON

Cadeia de caracteres de mensagem com os detalhes do status da operação:

Mensagem	Descrição
Sucesso – mensagem	A senha do usuário foi substituída
Falha – erro	Falha na autenticação do usuário
Falha – erro	O usuário não existe
Falha – erro	A senha não atende à 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	Obrigatório
admin_password	String	Obrigatório
username	String	Obrigatório
new_password	String	Obrigatório

Comando de cURL

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 para IoT para usar essa API.

URI: /external/authentication/validation

POST

Solicitação

Tipo: JSON

Parâmetros de consulta

Nome	Tipo	Obrigatório/Opcional
username	String	Obrigatório
password	String	Obrigatório

Exemplo de solicitação

request:

{

    "username": "test",
    "password": "Test12345\!"

}

Resposta

Tipo: JSON

Cadeia de caracteres de mensagem com os detalhes do status da operação:

Mensagem	Descrição
Sucesso – mensagem	Autenticação bem-sucedida
Falha – erro	Falha na validação das credenciais

Exemplo de resposta

response:

{

    "msg": "Authentication succeeded."

}

Comando de cURL

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óximas etapas

Para obter mais informações, confira a Visão geral de referência da API do Defender para IoT.