Application 목록 조회
    • PDF

    Application 목록 조회

    • PDF

    기사 요약

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

    Application 목록을 조회합니다.

    요청

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

    메서드URI
    GET/api/v1/applications

    요청 헤더

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

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    searchColumnStringConditional검색 컬럼
    • applicationId | applicationName
      • applicationId: Application 아이디
      • applicationName: Application 이름
    • searchWord를 입력한 경우, 필수
    searchWordStringOptional검색 키워드
    • 검색 컬럼 옵션(applicationId, applicationName)과 전체 또는 부분 일치하지 않는 값을 입력한 경우, 응답 시 items가 빈 값 []으로 표시
    • searchColumn 없이 요청하는 경우, 전체 목록 표시
    pageIntegerOptional페이지 번호
    • 0~N (기본값: 0)
    sizeIntegerOptional페이지 출력 수
    • 1~N (기본값: 20)

    요청 예시

    요청 예시는 다음과 같습니다.

    curl --location --request GET 'https://sso.apigw.gov-ntruss.com/api/v1/applications?searchColumn=applicationName&searchWord=application&page=0&size=20' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    pageNumber-페이지 번호
    totalPagesNumber-전체 페이지 수
    totalItemsNumber-응답 결과 수
    isFirstBoolean-첫 페이지 여부
    • true | false
      • true: 첫 페이지
      • false: 첫 페이지 아님
    isLastBoolean-마지막 페이지 여부
    • true | false
      • true: 마지막 페이지
      • false: 마지막 페이지 아님
    hasPreviousBoolean-이전 페이지 존재 여부
    • true | false
      • true: 존재
      • false: 존재 안 함
    hasNextBoolean-다음 페이지 존재 여부
    • true | false
      • true: 존재
      • false: 존재 안 함
    itemsArray-Application 목록

    items

    items에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    applicationIdString-Application 아이디
    nameString-Application 이름
    descriptionString-Application 설명
    applicationUrlString-Application URL
    applicationTypeString-Application 유형
    • web | app
      • web: 웹
      • app: 앱
    mbrLoginAllowString-메인 계정 로그인 허용 여부
    • ALLOW | DENY
      • ALLOW: 허용
      • DENY: 거부
    createdAtString-Application 생성 일시
    • ISO 8601 형식
    • OAuth 2.0
    updatedAtString-Application 수정 일시
    • ISO 8601 형식
    • OAuth 2.0
    clientIdString-Application Client 아이디
    • OAuth 2.0
    clientAuthMethodString-Application 인증 방식
    • client_secret_basic | client_secret_post | none
      • client_secret_basic: Client 자격 증명을 HTTP Basic 인증 헤더로 전달
      • client_secret_post: Client 아이디와 Secret을 POST 요청 본문에 포함
      • none: 인증 안 함
    • OAuth 2.0
    redirectUrisArray-Application 리디렉션 URI 목록
    • OAuth 2.0
    accessTypeString-Application 접근 방식
    • confidential | public
      • confidential: Client 아이디 및 Secret으로 인증 후 접근
      • public: Client 아이디로 인증 후 접근
    • OAuth 2.0
    grantTypesArray-권한 부여 방식
    • 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
    scopesArray-Application 접근 가능 정보 범위
    • profile | openid | groups
      • profile: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름
      • openid: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름
      • groups: 계정 구분, 로그인 아이디, 회원 고유 식별자, 사용자 이름, 그룹
    • OAuth 2.0
    accessTokenValidityNumber-Access Token 유효 기간(초)
    • OAuth 2.0
    refreshTokenValidityNumber-Refresh Token 유효 기간(초)
    • OAuth 2.0
    protocolString-Application 인증 프로토콜
    • OAUTH2: OAuth 2.0 (유효 값)

    응답 상태 코드

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

    응답 예시

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

    {
        "page" : 0,
        "totalPages" : 1,
        "totalItems" : 1,
        "isFirst" : true,
        "isLast" : true,
        "hasPrevious" : false,
        "hasNext" : false,
        "items" : [
            {
                "applicationId" : "88d2009c-****-****-****-59bf9afd5695",
                "name" : "application000",
                "description" : "aplication000 description",
                "applicationUrl" : "http://****.com",
                "applicationType" : "web",
                "mbrLoginAllow" : "ALLOW",
                "createdAt" : "2025-01-17T05:09:54Z",
                "updatedAt" : "2025-01-17T05:09:54Z",
                "clientId" : "88d2009c-****-****-****-59bf9afd5695",
                "clientAuthMethod" : "client_secret_basic",
                "redirectUris" : [
                    "http://****.com"
                ],
                "accessType" : "confidential",
                "grantTypes" : [
                    "authorization_code",
                    "refresh_token"
                ],
                "scopes" : [
                    "profile"
                ],
                "accessTokenValidity" : 43200,
                "refreshTokenValidity" : 2592000,
                "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.