Applicationの更新
    • PDF

    Applicationの更新

    • PDF

    記事の要約

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

    Application情報を更新します。

    リクエスト

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

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

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    applicationIdStringRequiredApplication ID

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    nameStringRequiredApplication名
    • 英数字、記号の「.」、「-」、「_」を組み合わせて2~100文字以内で入力
    • 先頭文字は英字または数字のみ使用
    descriptionStringOptionalApplicationの説明
    • 0~500文字
    applicationUrlStringOptionalApplication URL
    applicationTypeStringOptionalApplicationタイプ
    • web (デフォルト) | app
      • web: ウェブ
      • app: アプリ
    mbrLoginAllowStringRequiredメインアカウントでログインできるかどうか
    • ALLOW | DENY
      • ALLOW: 許可
      • DENY: 拒否
    redirectUrisArrayRequiredApplicationリダイレクト URIリスト
    • 1~10個以内で入力
    • OAuth 2.0
    clientAuthMethodStringRequiredApplicationの認証方法
    • 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
    accessTypeStringRequiredApplicationアクセス方法
    • confidential | public
      • confidential: Client IDと Secretで認証してアクセス
      • public: Client IDで認証してアクセス
    • OAuth 2.0
    grantTypesArrayRequired権限付与方法
    • 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
    scopesArrayRequiredApplicationのアクセス可能な情報の範囲
    • profile | openid | groups
      • profile: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名
      • openid: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名
      • groups: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名、グループ
    • OAuth 2.0
    accessTokenValidityNumberOptionalAccess Tokenの有効期間(秒)
    • 43200 (デフォルト)
    • OAuth 2.0
    refreshTokenValidityNumberOptionalRefresh Tokenの有効期間(秒)
    • 2592000 (デフォルト)
    • OAuth 2.0
    consentPageObjectRequired個人情報提供同意ページ情報
    consentPage.applicationNameObjectRequired提供を受ける者情報
    consentPage.applicationName.koStringRequired提供を受ける者(韓国語)
    consentPage.applicationName.enStringRequired提供を受ける者(英語)
    consentPage.applicationName.jaStringRequired提供を受ける者(日本語)
    consentPage.useLanguagesArrayRequired使用言語
    • ko | en | ja
      • ko: 韓国語
      • en: 英語
      • ja: 日本語
    consentPage.defaultLanguageStringRequiredデフォルト言語
    • ko | en | ja
      • ko: 韓国語
      • en: 英語
      • ja: 日本語
    consentPage.usePurposeDescObjectRequired利用目的情報
    consentPage.usePurposeDesc.koStringRequired利用目的(韓国語)
    consentPage.usePurposeDesc.enStringRequired利用目的(英語)
    consentPage.usePurposeDesc.jaStringRequired利用目的(日本語)
    consentPage.usePeriodDescObjectRequired保有・利用期間情報
    consentPage.usePeriodDesc.koStringRequired保有・利用期間(韓国語)
    consentPage.usePeriodDesc.enStringRequired保有・利用期間(英語)
    consentPage.usePeriodDesc.jaStringRequired保有・利用期間(日本語)
    consentPage.dataTransferAbroadBooleanRequired個人情報の海外移転
    • true | false
      • true: 移転
      • false: 移転しない
    consentPage.dataTransferCountryObjectConditional移転先の国情報
    • dataTransferAbroadtrueの場合、必ず入力
    consentPage.dataTransferCountry.koStringConditional移転先の国(韓国語)
    consentPage.dataTransferCountry.enStringConditional移転先の国(英語)
    consentPage.dataTransferCountry.jaStringConditional移転先の国(日本語)
    consentPage.dataRecipientsObjectConditional移転を受ける者情報
    • dataTransferAbroadtrueの場合は必ず入力
    consentPage.dataRecipients.koStringConditional移転を受ける法人名(韓国語)
    consentPage.dataRecipients.enStringConditional移転を受ける法人名(英語)
    consentPage.dataRecipients.jaStringConditional移転を受ける法人名(日本語)
    consentPage.dataRecipientsContactObjectConditional移転を受ける者の連絡先情報
    • dataTransferAbroadtrueの場合は必ず入力
    consentPage.dataRecipientsContact.koStringConditional移転を受ける法人の個人情報管理者の連絡先(韓国語)
    consentPage.dataRecipientsContact.enStringConditional移転を受ける法人の個人情報管理者の連絡先(英語)
    consentPage.dataRecipientsContact.jaStringConditional移転を受ける法人の個人情報管理者の連絡先(日本語)
    protocolStringRequiredApplicationプロトコル
    • OAUTH2: OAuth 2.0 (有効値)
    参考

    リクエストボディに含まれるフィールドのみ更新され、含まれないフィールドは更新されません。

    リクエスト例

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

    curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/applications/13080d64-****-****-****-c176d6cafd34' \
    --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"
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    successBoolean-API処理結果
    • true | false
      • true: 成功
      • false: 失敗
    messageString-結果メッセージ
    • successfalseの場合、表示

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

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

    レスポンス例

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

    {
        "success": true
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.