Tenant 조회

인쇄
공유
PDF

기사 요약

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

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

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

Tenant의 상세 정보를 조회합니다.

요청

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

메서드	URI
GET	/api/v1/tenant

요청 헤더

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

요청 예시

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/tenant' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`tenantId`	String	-	Tenant 아이디
`tenantAlias`	String	-	Tenant Alias(별칭)
`mbrLoginAllow`	String	-	메인 계정 로그인 허용 여부 `UNUSED` \| `ALLOW` \| `DENY` `UNUSED`: Application별 설정을 따름 `ALLOW`: 허용 `DENY`: 거부
`idleSessionExpDuration`	Integer	-	로그인한 외부 계정의 세션 만료 시간(초) `600` \| `1800` \| `3600` \| `10800`
`multipleLoginAllowed`	Boolean	-	중복 로그인 허용 여부 `true` \| `false` `true`: 허용 `false`: 허용 안 함 중복 로그인을 허용하지 않을 경우, SSO 역할당 1개 세션만 접속 가능
`organizationEnabled`	Boolean	-	Organization 연동 상태 `true` \| `false` `true`: 연동 완료 `false`: 연동 해제
`organizationEnabledAt`	String	-	Organization 연동 일시 ISO 8601 형식
`protocols`	Array	-	지원 프로토콜
`applicationTypeSupported`	Array	-	Application 유형
`oauth2`	Object	-	OAuth 2.0 정보
`oauth2.grantTypeSupported`	Array	-	권한 부여 방식 `authorization_code` \| `refresh_token` \| `implicit` `authorization_code`: 자체 생성한 Authorization code로 Access Token 발급 `refresh_token`: Access Token 만료 후 재로그인 없이 새 Access Token 발급 `implicit`: Authorization Code 없이 바로 Access Token 발급. 자격 증명을 안전하게 저장하기 힘든 Client 환경에 최적화
`oauth2.responseTypeSupported`	Array	-	OAuth 2.0 및 OpenID Connect 프로토콜에서 지원하는 응답 유형
`oauth2.scopeSupported`	Array	-	Application 접근 가능 정보 범위 `profile` \| `openid` \| `groups` `profile`: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름 `openid`: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름 `groups`: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름, 그룹
`oauth2.clientAuthMethodSupported`	Array	-	Application 인증 방식 `client_secret_basic` \| `client_secret_post` \| `none` `client_secret_basic`: Client 자격 증명을 HTTP Basic 인증 헤더로 전달 `client_secret_post`: Client 아이디와 Secret을 POST 요청 본문에 포함 `none`: 인증 안 함
`oauth2.accessTypeSupported`	Array	-	Application 접근 방식 `confidential` \| `public` `confidential`: Client 아이디 및 Secret으로 인증 후 접근 `public`: Client 아이디로 인증 후 접근
`isIdpExist`	Boolean	-	External IdP 생성 여부 `true` \| `false` `true`: 생성 `false`: 생성 안 함
`createdAt`	String	-	Tenant 생성 일시 ISO 8601 형식
`possessionAuthenticationEnabled`	Boolean	-	점유 인증 적용 여부 `true` \| `false` `true`: 적용 `false`: 미적용 점유 인증을 적용할 경우, 네이버 클라우드 플랫폼 내에서 SSO User의 인증된 이메일/SMS 정보 등록 및 관리 가능
`possessionAuthenticationTypes`	Array	-	점유 인증 수단 유형 `SMS` \| `Email` `SMS`: SMS `Email`: 이메일
`multiFactorAuthenticationEnabled`	Boolean	-	2차 인증 적용 여부 `true` \| `false` `true`: 적용 `false`: 미적용

응답 상태 코드

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

응답 예시

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

{
    "tenantId": "bc1fb745-****-****-****-9fc9f7c16369",
    "tenantAlias": "bc1fb745-****-****-****-9fc9f7c16369",
    "mbrLoginAllow": "UNUSED",
    "idleSessionExpDuration": 600,
    "multipleLoginAllowed": true,
    "organizationEnabled": true,
    "organizationEnabledAt": "2025-01-21T00:33:55Z",
    "protocols": [
        "OAUTH2"
    ],
    "applicationTypeSupported": [
        "app",
        "web"
    ],
    "oauth2": {
        "grantTypeSupported": [
            "authorization_code",
            "implicit",
            "refresh_token"
        ],
        "responseTypeSupported": [
            "code",
            "token",
            "id_token"
        ],
        "scopeSupported": [
            "profile",
            "openid",
            "groups"
        ],
        "clientAuthMethodSupported": [
            "client_secret_basic"
        ],
        "accessTypeSupported": [
            "confidential"
        ]
    },
    "isIdpExist": true,
    "createdAt": "2025-01-20T00:33:55Z",
    "possessionAuthenticationEnabled": true,
    "possessionAuthenticationTypes": [
        "SMS"
    ],
    "multiFactorAuthenticationEnabled": true
}

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

What's Next

Tenant 생성

요청
응답

태그

Ncloud Single Sign-On