MENU
      Viewing user list

        Viewing user list


        Article summary

        You can view a user list.

        Requests

        • GET /users

        Request parameters

        ParametersRequirement statusTypeDescriptionRestrictions
        searchColumnNStringSearch columnloginId, status, nrn, userId
        searchWordNStringSearch keyword
        pageNintPage numberDefault: 0
        sizeNintList sizeDefault: 20

        Responses

        Response bodies

        {
          "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"
        }
        JSON
        ParametersTypeDescriptionRestrictions
        pageNumberPage of the returned result
        totalPagesNumbertotalPage of the returned result
        totalItemsNumbertotalItems of the returned result
        hasPreviousBooleanWhether the current page has a previous page
        hasNextBooleanWhether the current page has a next page
        isFirstBooleanWhether the current page is the first page
        isLastBooleanWhether the current page is the last page
        items.[].userIdStringUser ID
        items.[].loginIdStringLogin ID (email)
        items.[].nrnStringnrn of the created user
        items.[].userProfileObjectUser profile
        items.[].userProfile.firstNameStringFirst name
        items.[].userProfile.lastNameStringLast name
        items.[].userProfile.emailStringEmail
        items.[].userProfile.emailVerifiedBooleanEmail verification status
        items.[].userProfile.empNoStringEmployee number
        items.[].userProfile.phoneCountryCodeStringCountry code for mobile phone number
        items.[].userProfile.phoneNoStringMobile phone number
        items.[].userProfile.phoneNoVerifiedBooleanMobile phone number verification status
        items.[].userProfile.deptNameStringDepartment name
        items.[].accessRulesObjectAccess rules
        accessRules.consoleAccessAllowedBooleanWhether console access is allowed
        items.[].accessRules.apiAccessAllowedBooleanWhether API access is allowed
        items.[].statusStringUser status (active, suspended, deleted)
        items.[].lastLoginAtStringLast login time (UTC, e.g., 2023-04-25T13:11:50Z)
        items.[].createdAtStringCreation time (UTC, e.g., 2023-04-25T13:11:50Z)
        items.[].updatedAtStringEdit time (UTC, e.g., 2023-04-25T13:11:50Z)
        items.[].descriptionStringUser description

        Errors

        Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
        For more information on common errors, see NAVER Cloud Platform API.

        HTTP status codeError codeError message
        400400Invalid request.

        Was this article helpful?

        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.