MENU
      SSO User 목록 조회
        • PDF

        SSO User 목록 조회

        • PDF

        기사 요약

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

        SSO User 목록을 조회합니다.

        요청

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

        메서드URI
        GET/api/v1/users

        요청 헤더

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

        요청 쿼리 파라미터

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

        필드타입필수 여부설명
        searchColumnStringConditional검색 컬럼
        • loginId | status | nrn | userId
          • loginId: SSO User 로그인 아이디
          • status: SSO User 상태
          • nrn: SSO User에 대한 네이버 클라우드 플랫폼 리소스 식별 값
          • userId: SSO User 아이디
        • searchWord를 입력하는 경우, 필수
        searchWordStringOptional검색 키워드
        • searchColumnstatus 입력 시, active(사용 중, 활성화) 또는 suspended(정지, 비활성화)로 검색 가능
        • 검색 컬럼 옵션(loginId, status, nrn, userId)과 전체 또는 부분 일치하지 않는 값을 입력한 경우, 응답 시 items가 빈 값 []으로 표시
        • searchColumn 없이 요청하는 경우, 전체 목록 표시
        pageIntegerOptional페이지 번호
        • 0~N (기본값: 0)
        sizeIntegerOptional페이지 출력 수
        • 1~N (기본값: 20)

        요청 예시

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

        curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/users?searchColumn=status&searchWord=active&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-User 목록

        items

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

        필드타입필수 여부설명
        userIdString-SSO User 아이디
        loginIdString-SSO User 로그인 아이디
        nrnString-SSO User에 대한 네이버 클라우드 플랫폼 리소스 식별 값
        userProfileObject-SSO User Profile 정보
        userProfile.firstNameString-SSO User 이름
        userProfile.lastNameString-SSO User 성
        userProfile.emailString-SSO User 이메일 주소
        userProfile.emailVerifiedBoolean-이메일 주소 인증 여부
        • true | false
          • true: 인증 완료
          • false: 인증 필요
        userProfile.empNoString-SSO User 사원 번호
        userProfile.phoneCountryCodeString-SSO User 국가 번호
        userProfile.phoneNoString-SSO User 핸드폰 번호
        userProfile.phoneNoVerifiedBoolean-핸드폰 번호 인증 여부
        • true | false
          • true: 인증 완료
          • false: 인증 필요
        userProfile.deptNameString-SSO User 부서 이름
        accessRulesObject-접근 규칙 정보
        accessRules.consoleAccessAllowedBoolean-콘솔 접근 허용 여부
        • true | false
          • true: 허용
          • false: 허용 안 함
        accessRules.apiAccessAllowedBoolean-API Gateway 접근 허용 여부
        • true | false
          • true: 허용
          • false: 허용 안 함
        statusString-SSO User 상태
        • active | suspended
          • active: 사용 중(활성화)
          • suspended: 정지(비활성화)
        descriptionString-SSO User 설명
        lastLoginAtString-SSO User 최종 접속 일시
        • ISO 8601 형식
        createdAtString-SSO User 생성 일시
        • ISO 8601 형식
        updatedAtString-SSO User 수정 일시
        • ISO 8601 형식

        응답 상태 코드

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

        응답 예시

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

        {
            "page": 0,
            "totalPages": 1,
            "totalItems": 1,
            "isFirst": true,
            "isLast": true,
            "hasPrevious": false,
            "hasNext": false,
            "items": [
                {
                    "userId": "80d9ba0d-****-****-****-76afe6ea5b33",
                    "loginId": "******@ncloud.com",
                    "nrn": "nrn:PUB:SSO::*******:User/80d9ba0d-****-****-****-76afe6ea5b33",
                    "userProfile": {
                        "firstName": "길동",
                        "lastName": "홍",
                        "email": "*******@ncloud.com",
                        "emailVerified": true,
                        "empNo": "00112233",
                        "phoneCountryCode": "82",
                        "phoneNo": "010-1111-1111",
                        "phoneNoVerified": true,
                        "deptName": "부서"
                    },
                    "accessRules": {
                        "consoleAccessAllowed": true,
                        "apiAccessAllowed": true
                    },
                    "status": "active",
                    "lastLoginAt": "2025-01-06T01:37:11Z",
                    "createdAt": "2025-01-03T05:08:42Z",
                    "updatedAt": "2025-01-06T01:37:11Z",
                    "description": "SSO User"
                }
            ]
        }
        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.