MFA 유형 일괄 설정

지정한 여러 계정의 다중 인증(MFA) 유형을 설정합니다. 대상 계정의 MFA가 활성화되어 있어야 합니다. 이 작업은 일부 동작 실패를 허용합니다. 유형을 변경하지 못한 계정이 있으면 failures 매개변수에 해당 계정의 식별자, 로그인 이름과 실패 원인을 반환합니다.

필요 권한

관리자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d guids="GUID1,GUID2,GUIDN" \
     -d type=OTP \
     -X POST https://HOSTNAME/api/sonar/users/mfa/type

요청 매개변수

MFA 유형

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

정상 응답

모두 성공

{
  "failures": []
}

• failures (배열): MFA 유형 설정에 실패한 계정의 오류 정보
  • id (문자열): 계정의 GUID
  • login (문자열): 로그인 계정 이름. 계정이 존재하지 않는 경우 생략
  • reason (문자열): 실패 원인

일부 성공

{
  "failures": [
    {
      "id": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "login": "gildong",
      "reason": "mfa-not-enabled"
    }
  ]
}

오류 응답

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

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "guids should be not null"
}

계정 식별자가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guids should be guid type."
}

지원하지 않는 MFA 유형을 지정한 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "not-support-mfa-type"
}

관리자 권한이 아닌 경우

HTTP 상태 코드 500 응답

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

계정이 존재하지 않는 경우

HTTP 상태 코드 200 응답

{
  "failures": [
    {
      "id": "6ba6031e-9d03-4a2b-8372-20ceee8f2a75",
      "reason": "user-not-found"
    }
  ]
}

상위 권한의 계정에 적용을 시도한 경우

HTTP 상태 코드 200 응답

{
  "failures": [
    {
      "id": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "login": "admin",
      "reason": "no-permission"
    }
  ]
}

MFA가 활성화되지 않은 경우

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

{
  "failures": [
    {
      "id": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "login": "gildong",
      "reason": "mfa-not-enabled"
    }
  ]
}