MENU
      Viewing list of groups including user

        Viewing list of groups including user


        Article summary

        You can view the list of groups to which a user belongs.

        Requests

        • GET /users/{userId}/groups

        Request path

        ParametersRequirement statusTypeDescriptionRestrictions
        userIdYStringUser Id

        Request parameters

        ParametersRequirement statusTypeRestrictionsDescription
        searchColumnNStringgroupName, groupNrn, groupIdSearch column
        groupName, groupNrn, groupId
        searchWordNStringSearch keyword
        pageNintPage number
        Default: 0
        sizeNintList size
        Default: 20

        Responses

        Response bodies

        {
          "page" : "integer",
          "totalPages" : "integer",
          "totalItems" : "integer",
          "hasPrevious" : "boolean",
          "hasNext" : "boolean",
          "items" : [ {
            "groupId":"String",
            "groupName":"String",
            "nrn":"String",
            "createdAt":"String",
            "updatedAt":"String",
            "description":"String",
            "relationCreatedAt":"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.[].groupIdStringGroup ID (UUID)
        items.[].groupNameStringGroup name
        items.[].nrnStringGroup nrn
        items.[].descriptionStringGroup description
        items.[].createdAtStringCreation time (UTC, e.g., 2023-04-25T13:11:50Z)
        items.[].updatedAtStringEdit time (UTC, e.g., 2023-04-25T13:11:50Z)
        items.[].relationCreatedAtStringAddition time: time when the user was added to the group (UTC, e.g., 2023-04-25T13:11:50Z))

        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
        4009050The user 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.