MENU
      Viewing list of users in group
        • PDF

        Viewing list of users in group

        • PDF

        Article summary

        You can view the list of users belonging to a group.

        Requests

        • GET /groups/{groupId}/users

        Request path

        ParametersRequirement statusTypeRestrictionsDescription
        groupIdYStringGroup Id

        Request parameters

        ParametersRequirement statusTypeRestrictionsDescription
        searchColumnNStringloginId, status, nrn, userId- Search column
        loginId, status, nrn, userId
        searchWordNStringSearch keyword
        pageNint- Page number
        Default: 0
        sizeNint- Number of results
        Default: 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"
        }
        Plain text
        ParametersTypeDescriptionRestrictions
        pageNumberPage of the returned result (required)
        totalPagesNumbertotalPage of the returned result (required)
        totalItemsNumbertotalItems of the returned result (required)
        hasPreviousBooleanWhether the current page has a previous page (required)
        hasNextBooleanWhether the current page has a next page (required)
        isFirstBooleanWhether the current page is the first page (required)
        isLastBooleanWhether the current page is the last page (required)
        items.[].userIdStringUser ID
        items.[].loginIdStringLogin ID
        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
        items.[].consoleAccessAllowedBooleanWhether console access is allowed
        items.[].apiAccessAllowedBooleanWhether API access is allowed
        items.[].statusStringUser statusactive, suspended
        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
        4009061Group does not exist

        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.