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

# 그룹 나열

> 모든 사용자 그룹 검색

# 그룹 나열

페이지 매김 및 필터링 옵션을 사용하여 시스템의 모든 사용자 그룹 목록을 검색합니다.

## 엔드포인트

```
GET /groups
```

## 설명

이 엔드포인트는 SecureAI 시스템에서 사용 가능한 모든 사용자 그룹을 반환합니다. 구성원, 권한, 메타데이터를 포함하여 각 그룹에 대한 자세한 정보를 제공합니다. 이는 사용자 액세스 및 조직 구조를 관리하는 데 유용합니다.

## 인증

**필수**: 관리자 권한이 있는 API 키

```
Authorization: Bearer sk-your-api-key-here
```

## 쿼리 매개변수

| 매개변수        | 유형  | 필수  | 설명   |                     |
| ----------- | --- | --- | ---- | ------------------- |
| `page`      | 정수  | 아니요 | 1    | 페이지 매김을 위한 페이지 번호   |
| `limit`     | 정수  | 아니요 | 20   | 페이지당 그룹 수(1-100)    |
| `search`    | 문자열 | 아니요 | -    | 그룹 이름 또는 설명에 대한 검색어 |
| `status`    | 문자열 | 아니요 | -    | 그룹 상태로 필터링          |
| `sortBy`    | 문자열 | 아니요 | 생성일자 | 정렬 기준 필드            |
| `sortOrder` | 문자열 | 아니요 | 설명   | 정렬 순서(오름차순, 내림차순)   |

## 요청 예시

```bash theme={null}
GET /groups?search=engineering&limit=20&page=1&sortBy=createdAt&sortOrder=desc
```

## 성공 응답

**상태 코드**: `200 OK`

```json theme={null}
{
  "success": true,
  "groups": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c25",
      "name": "Engineering Team",
      "description": "Software engineering and development team",
      "status": "Active",
      "userCount": 15,
      "users": [
        {
          "id": "60a7c8f5e8b4f5001f7a8c24",
          "name": "John Doe",
          "email": "john@example.com"
        }
      ],
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 25,
    "pages": 2
  }
}
```

### 응답 필드

| 필드                       | 유형  | 설명                  |
| ------------------------ | --- | ------------------- |
| `success`                | 부울  | 작업이 성공했는지 여부를 나타냅니다 |
| `groups[]`               | 배열  | 그룹 개체 배열            |
| `groups[].id`            | 문자열 | 고유 그룹 식별자           |
| `groups[].name`          | 문자열 | 그룹 이름               |
| `groups[].description`   | 문자열 | 그룹 설명               |
| `groups[].status`        | 문자열 | 그룹현황                |
| `groups[].userCount`     | 정수  | 그룹의 사용자 수           |
| `groups[].users`         | 배열  | 그룹의 사용자 개체 배열       |
| `groups[].users[].id`    | 문자열 | 사용자 ID              |
| `groups[].users[].name`  | 문자열 | 사용자 이름              |
| `groups[].users[].email` | 문자열 | 사용자 이메일             |
| `groups[].createdAt`     | 문자열 | 생성 타임스탬프            |
| `pagination`             | 개체  | 페이지 매김 정보           |

## 사용 예

### 자바스크립트

```javascript theme={null}
const listGroups = async (params = {}) => {
  const queryString = new URLSearchParams(params).toString();
  const url = `https://{customer.name}.hiperai.ai/api/external/groups${queryString ? `?${queryString}` : ''}`;
  
  const response = await fetch(url, {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here'
    }
  });
  
  return await response.json();
};

// Example usage
const result = await listGroups({
  search: 'engineering',
  limit: 10,
  page: 1,
  sortBy: 'createdAt',
  sortOrder: 'desc'
});
console.log(result.groups);
```

### 파이썬

```python theme={null}
import requests

def list_groups(params=None):
    url = "https://{customer.name}.hiperai.ai/api/external/groups"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here"
    }
    
    response = requests.get(url, headers=headers, params=params)
    return response.json()

# Example usage
params = {
    "search": "engineering",
    "limit": 10,
    "page": 1,
    "sortBy": "createdAt",
    "sortOrder": "desc"
}

result = list_groups(params)
print(result["groups"])
```

### cURL

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/groups?search=engineering&limit=10&page=1&sortBy=createdAt&sortOrder=desc" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

## 오류 응답

### 401 승인되지 않음

```json theme={null}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
```

### 403 금지됨

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Admin privileges required"
  }
}
```

### 429 요청이 너무 많습니다.

```json theme={null}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}
```

## 필터링 예

### 그룹 검색

```bash theme={null}
# Search by name
GET /groups?search=engineering

# Search by description
GET /groups?search=development
```

### 정렬 옵션

```bash theme={null}
# Sort by name ascending
GET /groups?sortBy=name&sortOrder=asc

# Sort by user count descending
GET /groups?sortBy=userCount&sortOrder=desc

# Sort by creation date
GET /groups?sortBy=createdAt&sortOrder=desc
```

### 페이지 매김

```bash theme={null}
# Get first 20 groups
GET /groups?limit=20&page=1

# Get next 20 groups
GET /groups?limit=20&page=2
```

## 사용 사례

* **그룹 관리**: 관리 목적으로 모든 그룹을 나열합니다.
* **사용자 조직**: 사용자 할당이 가능한 그룹을 검색합니다.
* **액세스 제어**: 그룹 권한 및 구성원 수 검토
* **보고**: 그룹 구조 및 구성원에 대한 보고서 생성
* **통합**: 애플리케이션 통합을 위한 그룹 검색

## 속도 제한

* **기본값**: 분당 요청 100개
* **일일**: 일일 요청 10,000건
* **월간**: 월간 요청 300,000건

## 메모

* 이 엔드포인트는 관리자만 접근할 수 있습니다.
* 페이지네이션: 오프셋이 아닌 페이지 매개변수 사용
* Flat Response: 응답이 데이터 개체 아래에 중첩되지 않습니다.
* 사용자 세부정보: 각 그룹 구성원의 전체 사용자 정보가 포함됩니다.
* 상태 필터: 그룹 상태별로 필터링 가능
* 검색 기능은 그룹 이름과 설명 전체에서 작동합니다.
* 정렬 옵션을 사용하면 다양한 기준에 따라 결과를 정리할 수 있습니다.


## OpenAPI

````yaml GET /groups
openapi: 3.0.3
info:
  title: SecureAI External API
  description: >
    SecureAI External API provides AI chat completion and image generation
    capabilities with knowledge base retrieval, 

    security policies, and comprehensive usage tracking. This API is designed
    for external developers 

    and integrations using API key authentication.


    ## Key Features

    - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge
    bases for relevant context

    - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI
    models

    - **Model Redundancy & Failover**: Caller-defined failover chains (primary +
    fallbacks) with per-attempt timeouts

    - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1`
    — no code changes

    - **Image Generation**: Generate and edit images using Google Gemini 2.5
    Flash Image

    - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI
    Realtime API with WebRTC

    - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield,
    and signed compliance receipts

    - **Usage Tracking**: Comprehensive usage monitoring, self-service quota,
    and rate limiting

    - **Knowledge Base Integration**: Access to personal and shared knowledge
    bases

    - **User Management**: Complete user, group, and role management
    capabilities

    - **Audit Logging**: Comprehensive activity and security audit logs


    ## Authentication

    All endpoints (except health check) require API key authentication using
    Bearer token:

    ```

    Authorization: Bearer sk-your-api-key-here

    ```


    ## Billing and Usage

    By default, API requests are billed to the user account that owns the API
    key. You can specify 

    a different user to bill by including the `user_id` parameter in your
    request. This allows for:

    - Multi-tenant applications with per-user billing

    - Flexible completion limit management

    - Per-user "Usage by Model" settings


    ## Rate Limits

    - Default: 60 requests per minute, 1000 requests per hour

    - Daily limits: 100 requests (configurable)

    - Monthly limits: 10,000 requests (configurable)


    ## Base URL

    ```

    https://secureai.hiperai.ai/api/external

    ```
  version: 1.1.0
  contact:
    name: SecureAI Support
    email: support@secureai.hiperai.ai
  license:
    name: Proprietary
    url: https://secureai.hiperai.ai/terms
servers:
  - url: https://secureai.hiperai.ai/api/external
    description: Production server
  - url: http://localhost:3010/api/external
    description: Development server
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: System health and status endpoints
  - name: Discovery
    description: Endpoints to discover available models, indexes, and policies
  - name: Chat
    description: AI chat completion endpoints
  - name: User Management
    description: Endpoints for managing user accounts and roles
  - name: Index Management
    description: Endpoints for managing knowledge base indexes
  - name: Group Management
    description: Endpoints for managing user groups
  - name: SMLTP Security
    description: Endpoints for managing SMLTP security policies and audit logs
  - name: Role Management
    description: Endpoints for managing user roles
  - name: Activity Logs
    description: Endpoints for retrieving activity logs
externalDocs:
  description: SecureAI Documentation
  url: https://secureai.hiperai.ai/docs
paths:
  /groups:
    get:
      tags:
        - Group Management
      summary: Get All Groups
      description: >
        Retrieve all groups with pagination and filtering. Only accessible by
        administrators.
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          description: Number of groups per page
          required: false
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
        - name: search
          in: query
          description: Search term for group name or description
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: Filter by group status
          required: false
          schema:
            type: string
            enum:
              - Active
              - Inactive
        - name: sortBy
          in: query
          description: Field to sort by
          required: false
          schema:
            type: string
            default: createdAt
        - name: sortOrder
          in: query
          description: Sort order
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
      responses:
        '200':
          description: List of groups
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 60a7c8f5e8b4f5001f7a8c25
                        name:
                          type: string
                          example: Engineering Team
                        description:
                          type: string
                          example: Software engineering team
                        status:
                          type: string
                          example: Active
                        userCount:
                          type: integer
                          example: 15
                        users:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 60a7c8f5e8b4f5001f7a8c24
                              name:
                                type: string
                                example: John Doe
                              email:
                                type: string
                                example: john@example.com
                        createdAt:
                          type: string
                          format: date-time
                          example: '2024-01-01T00:00:00.000Z'
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        example: 1
                      limit:
                        type: integer
                        example: 20
                      total:
                        type: integer
                        example: 50
                      pages:
                        type: integer
                        example: 3
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied - admin only
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Invalid API key
        message:
          type: string
          example: The provided API key is invalid or has been revoked
        request_id:
          type: string
          example: req-abc123
          description: Request ID for tracking (if available)
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key authentication using Bearer token format.
        Example: `Authorization: Bearer sk-your-api-key-here`

````