Applicationの作成

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

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

Applicationを作成します。

リクエスト

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

メソッド URI
POST /api/v1/applications

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

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

リクエスト例

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

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/groups/12cfbd94-****-****-****-2ff725201395' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "name" : "application000",
    "description" : "aplication000 description",
    "applicationUrl" : "http://****.com",
    "applicationType" : "web",
    "mbrLoginAllow" : "ALLOW",
    "redirectUris" : [
        "http://****.com"
    ],
    "clientAuthMethod" : "client_secret_basic",
    "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"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
applicationId String - Application ID
oauth2 Object - OAuth 2.0情報
oauth2.clientId String - 作成された OAuth Client ID
oauth2.secret String - 作成された OAuth Client Secret
protocol String - Applicationプロトコル
  • OAUTH2: OAuth 2.0

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

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

レスポンス例

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

{
    "applicationId": "b1bbb54f-****-****-****-6dfdf7fb94a6",
    "oauth2": {
        "clientId": "b1bbb54f-****-****-****-6dfdf7fb94a6",
        "clientSecret": "d1517905-****-****-****-3b3010784920"
    },
    "protocol": "OAUTH2"
}