Project & User Management API Reference

Learn about the APIs for querying project information and managing user permissions programmatically within the GIIP platform.

🔌 Go to Project List Feature →

📋 Overview

This API module provides features to control information for Projects, the logical management units of the GIIP system, and Users who have access to those projects.

🔐 Authentication & Headers

All requests must include common authentication headers.

Header:
```
x-giip-ak: [Your Access Key]
```
Header:
```
x-giip-sk: [Your Secret Key]
```

🚀 Key API Endpoints

1. Get Project List

URL:
```
POST /api/project/list
```
Description: Returns a list of all projects accessible from the current account (CSN).
Request Body:

{
  "searchKeyword": ""
}

2. Get Project Detail

URL:
```
POST /api/project/detail
```
Description: Queries detailed settings and the number of assigned assets for a specific project.
Request Body:

{
  "projectIsn": 123
}

3. Get Project Users

URL:
```
POST /api/project/users
```
Description: Queries the list of users assigned to a specific project and their respective permission levels.
Request Body:

{
  "projectIsn": 123
}

🔍 Response Data Example

{
  "RstVal": 0,
  "RstMsg": "Success",
  "Data": [
    {
      "projectIsn": 123,
      "projectName": "Mobile App Backend",
      "userCount": 5,
      "serverCount": 12,
      "dbCount": 2
    }
  ]
}

💡 Use Cases

CI/CD Pipeline: Receive the server list of a target project via API before deployment to trigger parallel package updates.
Permission Auditing: Regularly extract the user permission list per project to create security reports.

🛡️ Using Sk3 (High-fidelity Logging)

For administrative tasks that affect the overall infrastructure structure, such as registering new projects or modifying service groups, we recommend the

giipApiSk3

endpoint to ensure task integrity and for detailed audit logs.

Endpoint:

https://giipfaw.azurewebsites.net/api/giipApiSk3

Advantages: If a project creation fails, it immediately records the caller's detailed environment information (IP, UA) and StackTrace, allowing for rapid analysis of configuration errors or permission issues.
Usage Tip: By utilizing the
```
text
```
command and the
```
jsondata
```
parameter substitution feature, you can safely manage complex service group descriptions or non-English names without data loss.

Version: 1.1 Last Updated: 2026-04-10 Source:

giipv3/public/help/api-project-user.en.md

Related Documents:

API Result Codes Guide (RstVal)