2차 인증 정보 조회

Classic/VPC 환경에서 이용 가능합니다.

서브 계정의 2차 인증 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/sub-accounts/{subAccountId}/mfa

요청 헤더

Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`subAccountId`	String	Required	서브 계정 아이디 서브 계정 목록 조회 참조

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/mfa' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`isMfaMandatory`	Boolean	-	2차 인증 필수 여부 `true` \| `false` `true`: 필수 `false`: 선택
`mfaList`	Array	-	MFA 설정 정보

mfaList

mfaList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`mfaType`	String	-	2차 인증 수단 유형 `PHONE` \| `EMAIL` \| `OTP` \| `PASSKEY` `PHONE`: 휴대 전화 `EMAIL`: 이메일 `OTP`: 네이버 클라우드 플랫폼 인증 OTP `PASSKEY`: 패스 키

응답 상태 코드

Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "isMfaMandatory": true,
  "mfaList": [
    {
      "mfaType": "EMAIL"
    },
    {
      "mfaType": "PASSKEY"
    },
    {
      "mfaType": "PHONE"
    }
  ]
}