MENU
      Assignment 계정 목록 조회
        • PDF

        Assignment 계정 목록 조회

        • PDF

        기사 요약

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

        Assignment에 추가한 계정 목록을 조회합니다.

        요청

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

        메서드URI
        GET/api/v1/assignments/accounts

        요청 헤더

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

        요청 쿼리 파라미터

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

        필드타입필수 여부설명
        searchWordStringOptional검색 키워드
        • URL 인코딩 필요
        • accountName과 전체 또는 부분 일치하지 않는 값을 입력한 경우, 응답 시 items가 빈 값 []으로 표시
        • searchColumn 없이 요청하는 경우, 전체 목록 표시
        searchColumnStringConditional검색 컬럼
        • accountName: 대상 계정 이름 (유효 값)
          • <예시> searchColumn=accountName
        • 유효하지 않은 값을 입력한 경우, 전체 목록 표시
        • searchWord를 입력하는 경우, 필수
        pageIntegerOptional페이지 번호
        • 0~N (기본값: 0)
        sizeIntegerOptional페이지 출력 수
        • 1~N (기본값: 20)

        요청 예시

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

        curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/assignments/accounts?searchColumn=accountName&searchWord=%ED%99%8D%EA%B8%B8%EB%8F%99&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}'
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

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

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

        items

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

        필드타입필수 여부설명
        accountNameString-계정 사용자 이름
        accountAliasString-계정 별칭
        accountLoginIdString-계정 로그인 아이디
        accountTypeString-계정 유형
        • Master | Member
          • Master: 마스터 계정
          • Member: 멤버 계정
        accountGroupString-계정 그룹
        accountMbrNoNumber-계정 회원 번호(MemberNo)

        응답 상태 코드

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

        응답 예시

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

        {
            "page": 0,
            "totalPages": 1,
            "totalItems": 1,
            "isFirst": true,
            "isLast": true,
            "hasPrevious": false,
            "hasNext": false,
            "items": [
                {
                    "accountName": "홍길동",
                    "accountAlias": "-",
                    "accountLoginId": "******@ncloud.com",
                    "accountType": "-",
                    "accountGroup": "-",
                    "accountMbrNo": *******
                }
            ]
        }
        JSON

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

        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.