Get group list

Available in Classic and VPC

Get the group list.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v1/groups

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`page`	Integer	Optional	Page number 0-N (default: 0)
`size`	Integer	Optional	Page output count 1-N (default: 10)

Request example

The request example is as follows:

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/groups' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`page`	Integer	-	Page number
`totalPages`	Integer	-	Total number of pages
`totalItems`	Integer	-	Number of response results
`hasPrevious`	Boolean	-	Whether previous page exists `true` \| `false` `true`: It exists `false`: It doesn't exist
`hasNext`	Boolean	-	Whether next page exists `true` \| `false` `true`: It exists `false`: It doesn't exist
`items`	Array	-	Group list
`isFirst`	Boolean	-	Whether it is the first page `true` \| `false` `true`: first page `false`: not a first page
`isLast`	Boolean	-	Whether it is the last page `true` \| `false` `true`: last page `false`: not a last page

`items`

The following describes items.

Field	Type	Required	Description
`groupId`	String	-	Group ID
`groupName`	String	-	Group name
`nrn`	String	-	NAVER Cloud Platform resource identification value for group

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

{
    "page": 0,
    "totalPages": 1,
    "totalItems": 2,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "groupId": "50b77400-****-****-****-246e96591a38",
            "groupName": "group001",
            "nrn": "nrn:PUB:IAM::2768364:Group/50b77400-****-****-****-246e96591a38"
        },
        {
            "groupId": "c046b960-****-****-****-246e96591594",
            "groupName": "group",
            "nrn": "nrn:PUB:IAM::2768364:Group/c046b960-****-****-****-246e96591594"
        }
    ],
    "isFirst": true,
    "isLast": true
}