이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.
Ncloud 표준 표현을 적용한 API입니다.
SSO User에 추가한 MFA Device를 조회합니다. MFA Device는 SSO User당 1개 등록됩니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /users/{userId}/mfa-device |
요청 헤더
Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
userId |
String (uuid) | Required | SSO User 아이디
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://sso.apigw.fin-ntruss.com/api/v2/users/1a2b3c4d-1111-4abc-8def-0123456789ab/mfa-device' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
certType |
String | - | 인증 수단
|
certInfo |
String | - | 인증 수단별 등록 정보. OTP는 등록 키를 마스킹한 값(뒤 3자리만 노출)이며 등록 여부 표시 용도로만 사용 가능
|
createdDateTime |
String (date-time) | - | MFA Device 등록 일시
|
응답 상태 코드
Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.
이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 200 | - | - | 요청 처리 성공 |
| 404 | NotFound | One or more of the resources in the request does not exist in the system. | 잘못된 URL 요청, 마스터 계정에 Organization이 존재하지 않음, 존재하지 않는 관리형 정책(System Managed) 아이디 입력, SSO User에 MFA Device가 존재하지 않음 |
| 404 | ResourceNotFound | The specified resource could not be found. | 생성된 Tenant가 없음, 존재하지 않는 자원 아이디 입력 |
| 404 | UserNotFound | The specified user could not be found. | 존재하지 않는 SSO User 아이디 입력 |
응답 예시
응답 예시는 다음과 같습니다.
{
"certType": "OTP",
"certInfo": "*************FEP",
"createdDateTime": "2025-01-02T09:00:00Z"
}