---
title: "グループリストの照会"
slug: "get-groups"
updated: 2026-09-17T09:58:02Z
published: 2026-09-17T09:58:02Z
canonical: "api.ncloud-docs.com/get-groups"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# グループリストの照会

Classic/VPC環境で利用できます。

グループリストを照会します。

## リクエスト

リクエスト形式を説明します。 リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /api/v1/groups |

### リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、[Ncloud Single Sign-Onのリクエストヘッダ](/docs/ja/single-sign-on-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `searchWord` | String | Optional | 検索キーワード - `searchColumn`と全体または一部が一致しない値を入力した場合、レスポンス時に`items`は空の値`[]`で表示 - `searchColumn`なしでリクエストする場合、全リストを表示 |
| `searchColumn` | String | Conditional | 検索カラム - `groupName` \| `groupNrn` \| `groupId` - `groupName`: グループ名 - `groupNrn`: グループに対する NAVERクラウドプラットフォームリソースの識別値 - `groupId`: グループ ID |
| `page` | Integer | Optional | ページ番号 - 0~N (デフォルト: 0) |
| `size` | Integer | Optional | ページの出力数 - 1~N (デフォルト: 20) |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/groups?searchColumn=groupName&searchWord=group000&page=0&size=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `page` | Number | - | ページ番号 |
| `totalPages` | Number | - | ページの総数 |
| `totalItems` | Number | - | レスポンス結果数 |
| `isFirst` | Boolean | - | 最初のページかどうか - `true` \| `false` - `true`: 最初のページ - `false`: 最初のページではない |
| `isLast` | Boolean | - | 最後のページかどうか - `true` \| `false` - `true`: 最後のページ - `false`: 最後のページではない |
| `hasPrevious` | Boolean | - | 以前のページは存在するかどうか - `true` \| `false` - `true`: 存在する - `false`: 存在しない |
| `hasNext` | Boolean | - | 次のページは存在するかどうか - `true` \| `false` - `true`: 存在する - `false`: 存在しない |
| `items` | Array | - | グループリスト: [items](/docs/ja/get-groups#items) |

#### `items`

`items`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `groupId` | String | - | グループ ID |
| `groupName` | String | - | グループ名 |
| `nrn` | String | - | グループに対する NAVERクラウドプラットフォームリソースの識別値 |
| `description` | String | - | グループの説明 |
| `createdAt` | String | - | グループの作成日時 - ISO 8601形式 |
| `updatedAt` | String | - | グループの更新日時 - ISO 8601形式 |

### レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、[Ncloud Single Sign-Onのレスポンスステータスコード](/docs/ja/single-sign-on-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "page": 0,
    "totalPages": 1,
    "totalItems": 1,
    "isFirst": true,
    "isLast": true,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "groupId": "12cfbd94-****-****-*****-2ff725201395",
            "groupName": "group000",
            "nrn": "nrn:PUB:SSO::*******:Group/12cfbd94-****-****-*****-2ff725201395",
            "description": "group000 description",
            "createdAt": "2025-01-13T02:04:15Z",
            "updatedAt": "2025-01-13T02:56:27Z"
        }
    ]
}
```