OT 모니터링 센서에 대한 인증 및 암호 관리 API 참조
이 문서의 내용
이 문서에서는 Defender for IoT OT 센서에 대해 지원되는 인증 및 암호 관리 API를 나열합니다.
set_password(암호 변경)
이 API를 사용하여 사용자가 자신의 암호를 변경할 수 있습니다.
이 API를 사용하는 데 Defender for IoT 액세스 토큰이 필요하지 않습니다.
URI : /external/authentication/set_password
POST
형식 : JSON
예제 :
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
요청 매개 변수
이름
형식
필수/선택
username
String
필수
password
String
필수
new_password
String
필수
형식 : JSON
작업 상태 세부 정보를 포함하는 메시지 문자열:
메시지
Description
성공 – msg
암호가 바뀌었습니다.
실패 – 오류
사용자 인증 실패
실패 – 오류
암호가 보안 정책과 일치하지 않습니다.
예제 :
response:
{
"error": {
"userDisplayErrorMessage": "User authentication failure"
}
}
형식 : POST
API :
curl -k -X POST -d '{"username": "<USER_NAME>","password": "<CURRENT_PASSWORD>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json' https://<IP_ADDRESS>/api/external/authentication/set_password
예제 :
curl -k -X POST -d '{"username": "myUser","password": "1234@abcd","new_password": "abcd@1234"}' -H 'Content-Type: application/json' https://127.0.0.1/api/external/authentication/set_password
set_password_by_admin(관리자별 사용자 암호 업데이트)
이 API를 사용하여 시스템 관리자가 지정된 사용자에 대한 암호를 변경할 수 있습니다. Defender for IoT 관리자 사용자 역할은 API로 작업할 수 있습니다.
이 API를 사용하는 데 Defender for IoT 액세스 토큰이 필요하지 않습니다.
URI : /external/authentication/set_password_by_admin
POST
형식 : JSON
요청 예제
request:
{
"admin_username": "admin",
"admin_password: "Test0987"
"username": "test",
"new_password": "Test54321\!"
}
요청 매개 변수
이름
형식
필수/선택
관리자 사용자 이름
String
필수
관리자 암호
String
필수
username
String
필수
new_password
String
필수
형식 : JSON
작업 상태 세부 정보를 포함하는 메시지 문자열:
메시지
Description
성공 – msg
암호가 바뀌었습니다.
실패 – 오류
사용자 인증 실패
실패 – 오류
사용자가 없습니다.
실패 – 오류
암호가 보안 정책과 일치하지 않습니다.
실패 – 오류
사용자에게 암호 변경 권한이 없습니다.
응답 예제
response:
{
"error": {
"userDisplayErrorMessage": "The user 'test_user' doesn't exist",
"internalSystemErrorMessage": "The user 'test_user' doesn't exist"
}
}
형식 : POST
API :
curl -k -X POST -d '{"admin_username":"<ADMIN_USERNAME>","admin_password":"<ADMIN_PASSWORD>","username": "<USER_NAME>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json' https://<IP_ADDRESS>/api/external/authentication/set_password_by_admin
예제 :
curl -k -X POST -d '{"admin_user":"adminUser","admin_password": "1234@abcd","username": "myUser","new_password": "abcd@1234"}' -H 'Content-Type: application/json' https://127.0.0.1/api/external/authentication/set_password_by_admin
유효성 검사(사용자 자격 증명 유효성 검사)
이 API를 사용하여 Defender for IoT의 사용자 이름 및 암호에 대한 유효성을 검사합니다.
이 API를 사용하는 데 Defender for IoT 액세스 토큰이 필요하지 않습니다.
URI : /api/external/authentication/validation
POST
요청 유형 : JSON
쿼리 매개 변수
이름
형식
필수/선택
username
String
필수
password
String
필수
요청 예제:
request:
{
"username": "test",
"password": "Test12345\!"
}
형식 : JSON
작업 상태 세부 정보를 포함하는 메시지 문자열:
메시지
Description
성공 – msg
인증에 성공했습니다.
실패 - 오류
자격 증명 유효성 검사에 실패했습니다.
응답 예제
response:
{
"msg": "Authentication succeeded."
}
형식 : POST
API :
curl -k -X POST -H "Authorization: <AUTH_TOKEN>" -H "Content-Type: application/json" -d '{"username": <USER NAME>, "password": <PASSWORD>}' https://<IP_ADDRESS>/api/external/authentication/validation
예제 :
curl -k -X POST -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" -H "Content-Type: application/json" -d '{"username": "test", "password": "test"}' https://127.0.0.1/api/external/authentication/validation
다음 단계
자세한 내용은 Defender for IoT API 참조 개요 를 참조하세요.