User 목록 조회

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

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

User 목록을 조회합니다.

요청

GET /users

요청 파라미터

파라미터	필수 여부	타입	설명	제약사항
searchColumn	N	String	검색 컬럼	loginId, status, nrn, userId
searchWord	N	String	검색어
page	N	int	페이지 번호	기본값: 0
size	N	int	결과 목록 크기	기본값: 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"
}

파라미터	타입	설명
page	Number	반환받은 결과의 page
totalPages	Number	반환받은 결과의 totalPage
totalItems	Number	반환받은 결과의 totalItems
hasPrevious	Boolean	현재 페이지 기준으로 이전 페이지 존재 여부
hasNext	Boolean	현재 페이지 기준으로 다음 페이지 존재 여부
isFirst	Boolean	전체 페이지 기준으로 현재 페이지가 처음 페이지인지 여부
isLast	Boolean	전체 페이지 기준으로 현재 페이지가 마지막 페이지인지 여부
items.[].userId	String	유저 아이디
items.[].loginId	String	로그인 아이디(email)
items.[].nrn	String	생성된 유저 nrn
items.[].userProfile	Object	User profile
items.[].userProfile.firstName	String	이름
items.[].userProfile.lastName	String	성
items.[].userProfile.email	String	이메일
items.[].userProfile.emailVerified	Boolean	이메일 검증 여부
items.[].userProfile.empNo	String	사원 번호
items.[].userProfile.phoneCountryCode	String	핸드폰 번호 국가 번호
items.[].userProfile.phoneNo	String	핸드폰 번호
items.[].userProfile.phoneNoVerified	Boolean	핸드폰 번호 검증 여부
items.[].userProfile.deptName	String	부서명
items.[].accessRules	Object	접근 규칙
items.[].accessRules.consoleAccessAllowed	Boolean	콘솔 접근 허용 여부
items.[].accessRules.apiAccessAllowed	Boolean	API 접근 허용 여부
items.[].status	String	유저 상태(active, suspended, deleted)
items.[].lastLoginAt	String	최종 로그인 일시(UTC, 예: 2023-04-25T13:11:50Z)
items.[].createdAt	String	생성 일시(UTC, 예: 2023-04-25T13:11:50Z)
items.[].updatedAt	String	수정 일시(UTC, 예: 2023-04-25T13:11:50Z)
items.[].description	String	유저 설명

에러

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

HTTP status code	에러 코드	에러 메시지
400	400	잘못된 요청

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

What's Next

User 단건 조회

요청
응답
에러