MFA 유형 설정

지정한 계정의 다중 인증(MFA) 유형을 설정합니다. 유형을 변경하려면 대상 계정의 MFA가 활성화되어 있어야 합니다.

필요 권한

관리자 이상의 계정으로 이용할 수 있습니다. 단, 본인보다 상위 권한의 계정은 변경할 수 없습니다.

HTTP 요청

POST /api/sonar/users/:guid/mfa/type
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
     -d type=OTP \
     -X POST \
     https://HOSTNAME/api/sonar/users/bfd00bb0-be99-4fd5-8380-166f544975fa/mfa/type
요청 매개변수
경로 매개변수
타입설명비고
guid문자열계정 식별자36자
요청 본문 매개변수
필수타입설명비고
typeO문자열MFA 유형OTP, MAIL, SMS, PASSWORD 중 하나

MFA 유형

  • OTP: OTP 앱(Google Authenticator 등)을 통한 인증 코드 입력
  • MAIL: 이메일로 전송된 인증 코드 입력 (메일 서버 설정 필요)
  • SMS: SMS로 전송된 인증 코드 입력
  • PASSWORD: 추가 암호 입력

정상 응답

{}

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "type should be not null"
}
계정 식별자가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
계정이 존재하지 않는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "user-not-found"
}
지원하지 않는 MFA 유형을 지정한 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "not-support-mfa-type"
}
MFA가 활성화되지 않은 경우

HTTP 상태 코드 500 응답. MFA 유형을 변경하려면 먼저 대상 계정의 MFA가 활성화되어 있어야 합니다.

{
  "error_code": "illegal-state",
  "error_msg": "mfa-not-enabled"
}
상위 권한의 계정 변경을 시도한 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}