Applicationの照会

Classic/VPC環境で利用できます。

Applicationの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/applications/{applicationId}

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`applicationId`	String	Required	Application ID Applicationリストの照会を参照

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`applicationId`	String	-	Application ID
`name`	String	-	Application名
`description`	String	-	Applicationの説明
`applicationUrl`	String	-	Applicationに移動する URL
`applicationType`	String	-	Applicationのタイプ `web` \| `app` `web`: ウェブ `app`: アプリ
`mbrLoginAllow`	String	-	メインアカウントでログインできるかどうか `ALLOW` \| `DENY` `ALLOW`: 許可 `DENY`: 拒否
`createdAt`	String	-	Applicationの作成日時 ISO 8601形式 OAuth 2.0
`updatedAt`	String	-	Applicationの更新日時 ISO 8601形式 OAuth 2.0
`clientId`	String	-	Application Client ID OAuth 2.0
`clientAuthMethod`	String	-	Applicationの認証方法 `client_secret_basic` \| `client_secret_post` \| `none` `client_secret_basic`: Client認証情報を HTTP Basic認証ヘッダで渡す `client_secret_post`: Client IDと Secretを POSTリクエスト本文に含める `none`: 認証しない OAuth 2.0
`redirectUris`	Array	-	Applicationリダイレクト URIリスト OAuth 2.0
`accessType`	String	-	Applicationアクセス方法 `confidential` \| `public` `confidential`: Client IDと Secretで認証してアクセス `public`: Client IDで認証してアクセス OAuth 2.0
`grantTypes`	Array	-	権限付与方法 `authorization_code` \| `refresh_token` \| `implicit` `authorization_code`: 独自作成した Authorization codeで Access Tokenを発行 `refresh_token`: Access Tokenの期限切れ後、再ログインせずに Access Tokenを新規発行 `implicit`: Authorization codeなしで直接 Access Tokenを発行。認証情報を安全に保存するのが困難な Client環境に最適化 OAuth 2.0
`scopes`	Array	-	Applicationのアクセス可能な情報の範囲 `profile` \| `openid` \| `groups` \| `email` `profile`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名 `openid`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名 `groups`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名、グループ `email`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名、メール OAuth 2.0
`accessTokenValidity`	Number	-	Access Tokenの有効期間(秒) OAuth 2.0
`refreshTokenValidity`	Number	-	Refresh Tokenの有効期間(秒) OAuth 2.0
`consentPage`	Object	-	個人情報提供同意ページ情報
`consentPage.applicationName`	Object	-	提供を受ける者情報
`consentPage.applicationName.ko`	String	-	提供を受ける者(韓国語)
`consentPage.applicationName.en`	String	-	提供を受ける者(英語)
`consentPage.applicationName.ja`	String	-	提供を受ける者(日本語)
`consentPage.useLanguages`	Array	-	使用言語 `ko` \| `en` \| `ja` `ko`: 韓国語 `en`: 英語 `ja`: 日本語
`consentPage.defaultLanguage`	String	-	デフォルト言語 `ko` \| `en` \| `ja` `ko`: 韓国語 `en`: 英語 `ja`: 日本語
`consentPage.usePurposeDesc`	Object	-	利用目的情報
`consentPage.usePurposeDesc.ko`	String	-	利用目的(韓国語)
`consentPage.usePurposeDesc.en`	String	-	利用目的(英語)
`consentPage.usePurposeDesc.ja`	String	-	利用目的(日本語)
`consentPage.usePeriodDesc`	Object	-	保有・利用期間情報
`consentPage.usePeriodDesc.ko`	String	-	保有・利用期間(韓国語)
`consentPage.usePeriodDesc.en`	String	-	保有・利用期間(英語)
`consentPage.usePeriodDesc.ja`	String	-	保有・利用期間(日本語)
`consentPage.dataTransferAbroad`	Boolean	-	個人情報の海外移転 `true` \| `false` `true`: 移転 `false`: 移転しない
`consentPage.dataTransferCountry`	Object	-	移転先の国情報 `dataTransferAbroad`が`true`の場合、表示
`consentPage.dataTransferCountry.ko`	String	-	移転先の国(韓国語)
`consentPage.dataTransferCountry.en`	String	-	移転先の国(英語)
`consentPage.dataTransferCountry.ja`	String	-	移転先の国(日本語)
`consentPage.dataRecipients`	Object	-	移転を受ける者情報 `dataTransferAbroad`が`true`の場合、表示
`consentPage.dataRecipients.ko`	String	-	移転を受ける法人名(韓国語)
`consentPage.dataRecipients.en`	String	-	移転を受ける法人名(英語)
`consentPage.dataRecipients.ja`	String	-	移転を受ける法人名(日本語)
`consentPage.dataRecipientsContact`	Object	-	移転を受ける者の連絡先情報 `dataTransferAbroad`が`true`の場合は必ず入力
`consentPage.dataRecipientsContact.ko`	String	-	移転を受ける法人の個人情報管理者の連絡先(韓国語)
`consentPage.dataRecipientsContact.en`	String	-	移転を受ける法人の個人情報管理者の連絡先(英語)
`consentPage.dataRecipientsContact.ja`	String	-	移転を受ける法人の個人情報管理者の連絡先(日本語)
`protocol`	String	-	Applicationプロトコル `OAUTH2`: OAuth 2.0 (有効値)

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "applicationId" : "88d2009c-****-****-****-59bf9afd5695",
    "name" : "application000",
    "description" : "aplication000 description",
    "applicationUrl" : "http://****.com",
    "applicationType" : "web",
    "mbrLoginAllow" : "ALLOW",
    "createdAt" : "2025-01-17T05:09:54Z",
    "updatedAt" : "2025-01-17T05:09:54Z",
    "clientId" : "88d2009c-****-****-****-59bf9afd5695",
    "clientAuthMethod" : "client_secret_basic",
    "redirectUris" : [
        "http://****.com"
    ],
    "accessType" : "confidential",
    "grantTypes" : [
        "authorization_code",
        "refresh_token"
    ],
    "scopes" : [
        "profile"
    ],
    "accessTokenValidity" : 43200,
    "refreshTokenValidity" : 2592000,
    "consentPage" : {
        "applicationName" : {
            "ko" : "네이버 클라우드 플랫폼"
        },
        "useLanguages" : [
            "ko"
        ],
        "defaultLanguage" : "ko",
        "usePurposeDesc" : {
            "ko" : "로그인"
        },
        "usePeriodDesc" : {
            "ko" : "365일"
        },
        "dataTransferAbroad" : true,
        "dataTransferCountry" : {
            "ko" : "국가 이름"
        },
        "dataRecipients" : {
            "ko" : "네이버 클라우드 플랫폼"
        },
        "dataRecipientsContact" : {
            "ko" : "******@ncloud.com"
        }
    },
    "protocol" : "OAUTH2"
}