Tenantの照会

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 ID
`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` \| `email` `profile`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名 `openid`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名 `groups`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名、グループ `email`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名、メール
`oauth2.clientAuthMethodSupported`	Array	-	Applicationの認証方法 `client_secret_basic` \| `client_secret_post` \| `none` `client_secret_basic`: Client認証情報を HTTP Basic認証ヘッダで渡す `client_secret_post`: Client IDと Secretを POSTリクエスト本文に含める `none`: 認証しない
`oauth2.accessTypeSupported`	Array	-	Applicationアクセス方法 `confidential` \| `public` `confidential`: Client IDと Secretで認証してアクセス `public`: Client IDで認証してアクセス
`isIdpExist`	Boolean	-	External IdPを作成するかどうか `true` \| `false` `true`: 作成 `false`: 作成しない
`createdAt`	String	-	Tenantの作成日時 ISO 8601形式
`possessionAuthenticationEnabled`	Boolean	-	占有認証を適用するかどうか `true` \| `false` `true`: 適用 `false`: 適用しない占有認証を適用する場合、NAVERクラウドプラットフォームで 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",
            "email"
        ],
        "clientAuthMethodSupported": [
            "client_secret_basic"
        ],
        "accessTypeSupported": [
            "confidential"
        ]
    },
    "isIdpExist": true,
    "createdAt": "2025-01-20T00:33:55Z",
    "possessionAuthenticationEnabled": true,
    "possessionAuthenticationTypes": [
        "SMS"
    ],
    "multiFactorAuthenticationEnabled": true
}