Application 생성
    • PDF

    Application 생성

    • PDF

    기사 요약

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

    Application을 생성합니다.

    요청

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

    메서드URI
    POST/api/v1/applications

    요청 헤더

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

    요청 바디

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

    필드타입필수 여부설명
    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 아이디와 Secret을 POST 요청 본문에 포함
      • none: 인증 안 함
    • accessTypeconfidential인 경우, client_secret_basic 또는 client_secret_post 입력 가능
    • accessTypepublic인 경우, none만 입력 가능
    • OAuth 2.0
    accessTypeStringRequiredApplication 접근 방식
    • confidential | public
      • confidential: Client 아이디 및 Secret으로 인증 후 접근
      • public: Client 아이디로 인증 후 접근
    • 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: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름
      • openid: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름
      • groups: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름, 그룹
    • 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 POST 'https://sso.apigw.gov-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"
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    applicationIdString-Application 아이디
    oauth2Object-OAuth 2.0 정보
    oauth2.clientIdString-생성된 OAuth Client 아이디
    oauth2.secretString-생성된 OAuth Client Secret
    protocolString-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"
    }
    

    이 문서가 도움이 되었습니까?

    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.