Available in Classic and VPC
Edit application information.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
PUT | /api/v1/applications/{applicationId} |
Request headers
For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
applicationId |
String | Required | Application ID
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
name |
String | Required | Application name
|
description |
String | Optional | Application description
|
applicationUrl |
String | Optional | Application URL |
applicationType |
String | Optional | Application type
|
mbrLoginAllow |
String | Required | Whether to allow main account login
|
redirectUris |
Array | Required | Application redirection URI list
|
clientAuthMethod |
String | Required | Application authentication method
|
accessType |
String | Required | Application access method
|
grantTypes |
Array | Required | Authorization method
|
scopes |
Array | Required | Application accessible information range
|
accessTokenValidity |
Number | Optional | Access token validity time (second)
|
refreshTokenValidity |
Number | Optional | Refresh token validity time (second)
|
consentPage |
Object | Required | Personal information provision consent page information |
consentPage.applicationName |
Object | Required | Receiving party information |
consentPage.applicationName.ko |
String | Required | Receiving party (Korean) |
consentPage.applicationName.en |
String | Required | Receiving party (English) |
consentPage.applicationName.ja |
String | Required | Receiving party (Japanese) |
consentPage.useLanguages |
Array | Required | Language used
|
consentPage.defaultLanguage |
String | Required | Default language
|
consentPage.usePurposeDesc |
Object | Required | Usage purpose information |
consentPage.usePurposeDesc.ko |
String | Required | Usage purpose (Korean) |
consentPage.usePurposeDesc.en |
String | Required | Usage purpose (English) |
consentPage.usePurposeDesc.ja |
String | Required | Usage purpose (Japanese) |
consentPage.usePeriodDesc |
Object | Required | Retention and usage period information |
consentPage.usePeriodDesc.ko |
String | Required | Retention and usage period information (Korean) |
consentPage.usePeriodDesc.en |
String | Required | Retention and usage period information (English) |
consentPage.usePeriodDesc.ja |
String | Required | Retention and usage period information (Japanese) |
consentPage.dataTransferAbroad |
Boolean | Required | Whether personal information is transferred abroad
|
consentPage.dataTransferCountry |
Object | Conditional | Transferred country information
|
consentPage.dataTransferCountry.ko |
String | Conditional | Transferred country (Korean) |
consentPage.dataTransferCountry.en |
String | Conditional | Transferred country (English) |
consentPage.dataTransferCountry.ja |
String | Conditional | Transferred country (Japanese) |
consentPage.dataRecipients |
Object | Conditional | Receiving party information
|
consentPage.dataRecipients.ko |
String | Conditional | Receiving corporate name (Korean) |
consentPage.dataRecipients.en |
String | Conditional | Receiving corporate name (English) |
consentPage.dataRecipients.ja |
String | Conditional | Receiving corporate name (Japanese) |
consentPage.dataRecipientsContact |
Object | Conditional | Transferred party contact information
|
consentPage.dataRecipientsContact.ko |
String | Conditional | Contact information of the personal information admin of the receiving corporation (Korean) |
consentPage.dataRecipientsContact.en |
String | Conditional | Contact information of the personal information admin of the receiving corporation (English) |
consentPage.dataRecipientsContact.ja |
String | Conditional | Contact information of the personal information admin of the receiving corporation (Japanese) |
protocol |
String | Required | Application protocol
|
Only the fields included in the request body are edited, and the fields not included are not edited.
Request example
The request example is as follows:
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"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
success |
Boolean | - | API processing result
|
message |
String | - | Result message
|
Response status codes
For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.
Response example
The response example is as follows:
{
"success": true
}