External IDP 로그인 설정

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

External IdP의 로그인 정보를 설정합니다.

요청

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

메서드	URI
PUT	/api/v1/tenant/login-settings

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`idleSessionExpDuration`	Integer	Required	로그인한 외부 계정의 세션 만료 시간(초) `600` \| `1800` \| `3600` \| `10800`
`multipleLoginAllowed`	Boolean	Required	중복 로그인 허용 여부 `true` \| `false` `true`: 허용 `false`: 허용 안 함 중복 로그인을 허용하지 않을 경우, SSO 역할당 1개 세션만 접속 가능
`possessionAuthenticationEnabled`	Boolean	Required	점유 인증 적용 여부 `true` \| `false` `true`: 적용 `false`: 미적용 `multiFactorAuthenticationEnabled`가 `true`인 경우, `false` 불가능 점유 인증을 적용할 경우, 네이버 클라우드 플랫폼 내에서 SSO User의 인증된 이메일/SMS 정보 등록 및 관리 가능
`possessionAuthenticationTypes`	Array	Required	점유 인증 수단 유형 `SMS` \| `Email` `SMS`: SMS `Email`: 이메일 모두 입력 가능
`multiFactorAuthenticationEnabled`	Boolean	Required	2차 인증 적용 여부 `true` \| `false` `true`: 적용 `false`: 미적용 2차 인증을 적용할 경우, SSO User의 로그인 시 아이디와 비밀번호 입력 후 이메일/SMS/OTP 중 선택하여 추가 인증 진행

요청 예시

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

curl --location --request PUT 'https://sso.apigw.gov-ntruss.com/api/v1/tenant/login-settings' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "idleSessionExpDuration": "600",
    "multipleLoginAllowed": true,
    "possessionAuthenticationEnabled": true,
    "possessionAuthenticationTypes": [
        "SMS",
        "Email"
    ],
    "multiFactorAuthenticationEnabled": true
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
    "success": true
}