User 목록 조회
    • PDF

    User 목록 조회

    • PDF

    기사 요약

    User 목록을 조회합니다.

    요청

    • GET /users

    요청 파라미터

    파라미터필수 여부타입설명제약사항
    searchColumnNString검색 컬럼loginId, status, nrn, userId
    searchWordNString검색어
    pageNint페이지 번호기본값: 0
    sizeNint결과 목록 크기기본값: 20

    응답

    응답 바디

    {
      "page" : "integer",
      "totalPages" : "integer",
      "totalItems" : "integer",
      "hasPrevious" : "boolean",
      "hasNext" : "boolean",
      "items" : [ {
        "userId" : "string",
        "loginId" : "string",
        "nrn" : "string",
        "userProfile" : {
          "firstName" : "string",
          "lastName" : "string",
          "email" : "string",
          "emailVerified" : "boolean",
          "empNo" : "string",
          "phoneCountryCode" : "string",
          "phoneNo" : "string",
          "phoneNoVerified" : "boolean",
          "deptName" : "string"
        },
        "accessRules" : {
          "consoleAccessAllowed" : "boolean",
          "apiAccessAllowed" : "boolean"
        },
        "status" : "string",
        "description" : "string",
        "lastLoginAt" : "string",
        "createdAt" : "string",
        "updatedAt" : "string"
      } ],
      "isFirst" : "boolean",
      "isLast" : "boolean"
    }
    
    파라미터타입설명제약사항
    pageNumber반환받은 결과의 page
    totalPagesNumber반환받은 결과의 totalPage
    totalItemsNumber반환받은 결과의 totalItems
    hasPreviousBoolean현재 페이지 기준으로 이전 페이지 존재 여부
    hasNextBoolean현재 페이지 기준으로 다음 페이지 존재 여부
    isFirstBoolean전체 페이지 기준으로 현재 페이지가 처음 페이지인지 여부
    isLastBoolean전체 페이지 기준으로 현재 페이지가 마지막 페이지인지 여부
    items.[].userIdString유저 아이디
    items.[].loginIdString로그인 아이디(email)
    items.[].nrnString생성된 유저 nrn
    items.[].userProfileObjectUser profile
    items.[].userProfile.firstNameString이름
    items.[].userProfile.lastNameString
    items.[].userProfile.emailString이메일
    items.[].userProfile.emailVerifiedBoolean이메일 검증 여부
    items.[].userProfile.empNoString사원 번호
    items.[].userProfile.phoneCountryCodeString핸드폰 번호 국가 번호
    items.[].userProfile.phoneNoString핸드폰 번호
    items.[].userProfile.phoneNoVerifiedBoolean핸드폰 번호 검증 여부
    items.[].userProfile.deptNameString부서명
    items.[].accessRulesObject접근 규칙
    items.[].accessRules.consoleAccessAllowedBoolean콘솔 접근 허용 여부
    items.[].accessRules.apiAccessAllowedBooleanAPI 접근 허용 여부
    items.[].statusString유저 상태(active, suspended, deleted)
    items.[].lastLoginAtString최종 로그인 일시(UTC, 예: 2023-04-25T13:11:50Z)
    items.[].createdAtString생성 일시(UTC, 예: 2023-04-25T13:11:50Z)
    items.[].updatedAtString수정 일시(UTC, 예: 2023-04-25T13:11:50Z)
    items.[].descriptionString유저 설명

    에러

    아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 에러 응답 형식은 Error Response를 참고해 주십시오.
    공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참조해 주십시오.

    HTTP status code에러 코드에러 메시지
    400400잘못된 요청입니다.

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

    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.