Application 수정

Classic/VPC 환경에서 이용 가능합니다.

Application 정보를 수정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
PUT	/api/v1/applications/{applicationId}

요청 헤더

Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`applicationId`	String	Required	Application 아이디 Application 목록 조회 참조

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`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~10개 입력 가능 OAuth 2.0
`clientAuthMethod`	String	Required	Application 인증 방식 `client_secret_basic` \| `client_secret_post` \| `none` `client_secret_basic`: Client 자격 증명을 HTTP Basic 인증 헤더로 전달 `client_secret_post`: Client 아이디와 Secret을 POST 요청 본문에 포함 `none`: 인증 안 함 `accessType`이 `confidential`인 경우, `client_secret_basic` 또는 `client_secret_post` 입력 가능 `accessType`이 `public`인 경우, `none`만 입력 가능 OAuth 2.0
`accessType`	String	Required	Application 접근 방식 `confidential` \| `public` `confidential`: Client 아이디 및 Secret으로 인증 후 접근 `public`: Client 아이디로 인증 후 접근 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 환경에 최적화 OAuth 2.0
`scopes`	Array	Required	Application 접근 가능 정보 범위 `profile` \| `openid` \| `groups` `profile`: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름 `openid`: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름 `groups`: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름, 그룹 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	이전되는 국가 정보 `dataTransferAbroad`가 `true`인 경우, 필수 입력
`consentPage.dataTransferCountry.ko`	String	Conditional	이전되는 국가(한국어)
`consentPage.dataTransferCountry.en`	String	Conditional	이전되는 국가(영어)
`consentPage.dataTransferCountry.ja`	String	Conditional	이전되는 국가(일본어)
`consentPage.dataRecipients`	Object	Conditional	이전 받는 자 정보 `dataTransferAbroad`가 `true`인 경우, 필수 입력
`consentPage.dataRecipients.ko`	String	Conditional	이전 받는 법인 이름(한국어)
`consentPage.dataRecipients.en`	String	Conditional	이전 받는 법인 이름(영어)
`consentPage.dataRecipients.ja`	String	Conditional	이전 받는 법인 이름(일본어)
`consentPage.dataRecipientsContact`	Object	Conditional	이전 받는 자의 연락처 정보 `dataTransferAbroad`가 `true`인 경우, 필수 입력
`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 PUT 'https://sso.apigw.gov-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 처리 결과 `true` \| `false` `true`: 성공 `false`: 실패
`message`	String	-	결과 메시지 `success`가 `false`인 경우, 표시

응답 상태 코드

Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "success": true
}