Referência da API de gestão de autenticação e palavra-passe para consolas de gestão no local

Este artigo lista as APIs REST de gestão de autenticação e palavras-passe suportadas para Microsoft Defender para consolas de gestão no local do IoT.

set_password (Alterar palavra-passe)

Utilize esta API para permitir que os utilizadores alterem as suas próprias palavras-passe. Todas as funções de utilizador do Defender para IoT podem funcionar com a API.

Não precisa de um token de acesso do Defender para IoT para utilizar esta API.

URI: /external/authentication/set_password

POST

Pedir

Tipo: JSON

Exemplo:

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

Parâmetros do pedido

Nome	Tipo	Obrigatório/Opcional
nome de utilizador	String	Necessário
palavra-passe	String	Necessário
new_password	String	Necessário

Response

Tipo: JSON

Mensagem	Descrição
Êxito – msg	A palavra-passe foi substituída
Falha – erro	Falha na autenticação do utilizador
Falha – erro	A palavra-passe não corresponde à política de segurança

Exemplo de resposta

response:

{

    "error": {

        "userDisplayErrorMessage": "User authentication failure"

    }

}

comando 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 palavra-passe do utilizador por administrador do sistema)

Utilize esta API para permitir que os administradores de sistema alterem palavras-passe para utilizadores especificados. As funções de utilizador administrador do Defender para IoT podem funcionar com a API.

Não precisa de um token de acesso do Defender para IoT para utilizar esta API.

URI: /external/authentication/set_password_by_admin

POST

Pedir

Tipo: JSON

Exemplo de pedido

request:

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

Parâmetros do pedido

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

Response

Tipo: JSON

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

Mensagem	Descrição
Êxito – msg	A palavra-passe foi substituída
Falha – erro	Falha na autenticação do utilizador
Falha – erro	O utilizador não existe
Falha – erro	A palavra-passe não corresponde à política de segurança
Falha – erro	O utilizador não tem permissões para alterar a palavra-passe

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

comando 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 utilizador)

Utilize esta API para validar as credenciais de utilizador.

Não precisa de um token de acesso do Defender para IoT para utilizar esta API.

URI: /external/authentication/validation

POST

Pedir

Tipo: JSON

Parâmetros de consulta

Nome	Tipo	Obrigatório/Opcional
nome de utilizador	String	Necessário
palavra-passe	String	Necessário

Exemplo de pedido

request:

{

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

}

Response

Tipo: JSON

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

Mensagem	Descrição
Sucesso - msg	Autenticação com êxito
Falha - erro	Falha na validação de credenciais

Exemplo de resposta

response:

{

    "msg": "Authentication succeeded."

}

comando 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

Passos seguintes

Para obter mais informações, veja Descrição geral da referência da API do Defender para IoT.