Applicationの更新
- 印刷する
- PDF
Applicationの更新
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
Application情報を更新します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
PUT | /api/v1/applications/{applicationId} |
リクエストヘッダ
Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
applicationId | String | Required | Application ID |
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
name | String | Required | Application名
|
description | String | Optional | Applicationの説明
|
applicationUrl | String | Optional | Application URL |
applicationType | String | Optional | Applicationタイプ
|
mbrLoginAllow | String | Required | メインアカウントでログインできるかどうか
|
redirectUris | Array | Required | Applicationリダイレクト URIリスト
|
clientAuthMethod | String | Required | Applicationの認証方法
|
accessType | String | Required | Applicationアクセス方法
|
grantTypes | Array | Required | 権限付与方法
|
scopes | Array | Required | Applicationのアクセス可能な情報の範囲
|
accessTokenValidity | Number | Optional | Access Tokenの有効期間(秒)
|
refreshTokenValidity | Number | Optional | Refresh Tokenの有効期間(秒)
|
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 | 使用言語
|
consentPage.defaultLanguage | String | Required | デフォルト言語
|
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 | 個人情報の海外移転
|
consentPage.dataTransferCountry | Object | Conditional | 移転先の国情報
|
consentPage.dataTransferCountry.ko | String | Conditional | 移転先の国(韓国語) |
consentPage.dataTransferCountry.en | String | Conditional | 移転先の国(英語) |
consentPage.dataTransferCountry.ja | String | Conditional | 移転先の国(日本語) |
consentPage.dataRecipients | Object | Conditional | 移転を受ける者情報
|
consentPage.dataRecipients.ko | String | Conditional | 移転を受ける法人名(韓国語) |
consentPage.dataRecipients.en | String | Conditional | 移転を受ける法人名(英語) |
consentPage.dataRecipients.ja | String | Conditional | 移転を受ける法人名(日本語) |
consentPage.dataRecipientsContact | Object | Conditional | 移転を受ける者の連絡先情報
|
consentPage.dataRecipientsContact.ko | String | Conditional | 移転を受ける法人の個人情報管理者の連絡先(韓国語) |
consentPage.dataRecipientsContact.en | String | Conditional | 移転を受ける法人の個人情報管理者の連絡先(英語) |
consentPage.dataRecipientsContact.ja | String | Conditional | 移転を受ける法人の個人情報管理者の連絡先(日本語) |
protocol | String | Required | Applicationプロトコル
|
参考
リクエストボディに含まれるフィールドのみ更新され、含まれないフィールドは更新されません。
リクエスト例
リクエストのサンプルコードは次の通りです。
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"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
success | Boolean | - | API処理結果
|
message | String | - | 結果メッセージ
|
レスポンスステータスコード
Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"success": true
}
この記事は役に立ちましたか?