SSO User MFA Device 추가

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

SSO User에 MFA Device를 추가합니다.

요청

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

메서드	URI
POST	/api/v1/users/{userId}/mfa-devices

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`userId`	String	Required	SSO User 아이디 SSO User 목록 조회 참조

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`encodedKey`	String	Required	OTP 비밀 키 인증 앱 설정을 위해 제공된 키 입력 네이버 클라우드 플랫폼 콘솔의 Ncloud Single Sign-On > External IdP login > Users 메뉴 내 사용자 세부 정보 페이지에서 [MFA Device] 탭에 있는 [추가] 버튼을 클릭하여 확인
`otpNo`	String	Required	OTP 인증 번호 6자리 숫자 인증 앱 설정 후 화면에 표시된 숫자 입력

요청 예시

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

curl --location --request POST 'https://sso.apigw.gov-ntruss.com/api/v1/users/a5968927-****-****-****-28592d5ba924/mfa-devices' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "encodedKey": "****EKJGIC72****",
    "otpNo": "******"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`success`	Boolean	-	API 처리 결과 `true` \| `false` `true`: 성공 `false`: 실패
`message`	String	-	결과 메시지 `success`가 `false`인 경우, 표시

응답 상태 코드

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

응답 예시

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

{
    "success": true
}

이 문서가 도움이 되었습니까?

What's Next

SSO User MFA Device 삭제

요청
응답