Get All Users

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "users": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "John Doe",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "license": "Growth",
      "status": 1,
      "isVerified": true,
      "setupCompleted": true,
      "authType": "basic",
      "mfaEnabled": false,
      "customRole": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "custom_role",
        "displayName": "Custom Role"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "lastActive": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

GET

users

Get All Users

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "users": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "John Doe",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "license": "Growth",
      "status": 1,
      "isVerified": true,
      "setupCompleted": true,
      "authType": "basic",
      "mfaEnabled": false,
      "customRole": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "custom_role",
        "displayName": "Custom Role"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "lastActive": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

获取所有用户

通过分页和过滤检索所有用户。仅可由管理员访问。

端点

GET /users

说明

该端点允许管理员检索系统中所有用户的分页列表。它支持按各种标准进行过滤，包括角色、许可证、状态和搜索词。这是需要适当权限的管理端点。

身份验证

必填。将您的 API 密钥包含在授权标头中。

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

请求

查询参数

参数	类型	必填	默认	描述
`page`	整数	没有	1	分页页码
`limit`	整数	没有	20	20每页用户数 (1-100)
`search`	字符串	没有	-	姓名、电子邮件或用户名的搜索词
`role`	字符串	没有	-	按用户角色过滤（管理员、用户、globalReader）
`license`	字符串	没有	-	按用户许可证过滤（Essential、Growth、Ultra、Early Access）
`status`	整数	没有	-	按用户状态过滤（0=非活动，1=活动）
`sortBy`	字符串	没有	创建于	排序依据的字段
`sortOrder`	字符串	没有	描述	排序顺序（升序、降序）

请求示例

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20&role=user&status=1" \
  -H "Authorization: Bearer sk-your-api-key-here"

通过搜索：

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?search=john&license=Growth" \
  -H "Authorization: Bearer sk-your-api-key-here"

回应

成功响应 (200)

{
  "success": true,
  "users": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "John Doe",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "license": "Growth",
      "status": 1,
      "isVerified": true,
      "setupCompleted": true,
      "authType": "basic",
      "mfaEnabled": false,
      "customRole": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "custom_role",
        "displayName": "Custom Role"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "lastActive": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

响应字段

领域	类型	描述
`success`	布尔	对于成功的请求，始终 `true`
`users`	数组	用户对象数组
`users[].id`	字符串	用户的唯一标识符
`users[].name`	字符串	用户全名
`users[].username`	字符串	用户的用户名
`users[].email`	字符串	用户的电子邮件地址
`users[].role`	字符串	用户角色（管理员、用户、globalReader）
`users[].license`	字符串	用户许可级别（Essential、Growth、Ultra、Early Access）
`users[].status`	整数	用户状态（0=非活动，1=活动）
`users[].isVerified`	布尔	用户是否已验证
`users[].setupCompleted`	布尔	用户设置是否完成
`users[].authType`	字符串	身份验证类型（基本、auth0）
`users[].mfaEnabled`	布尔	是否启用MFA
`users[].customRole`	对象	自定义角色信息（如果已分配）
`users[].customRole.id`	字符串	自定义角色 ID
`users[].customRole.name`	字符串	自定义角色名称
`users[].customRole.displayName`	字符串	自定义角色显示名称
`users[].createdAt`	字符串	用户创建时间戳
`users[].updatedAt`	字符串	用户上次更新时间戳
`users[].lastActive`	字符串	用户上次活动时间戳
`pagination`	对象	分页信息
`pagination.page`	整数	当前页码
`pagination.limit`	整数	每页项目
`pagination.total`	整数	用户总数
`pagination.pages`	整数	总页数

用法示例

JavaScript

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

const data = await response.json();

if (data.success) {
  console.log(`Showing ${data.users.length} of ${data.pagination.total} users`);
  data.users.forEach(user => {
    console.log(`${user.name} (${user.email}) - ${user.role}`);
  });
}

###Python

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

params = {
    'page': 1,
    'limit': 20,
    'role': 'user',
    'status': 1
}

response = requests.get('https://{customer.name}.hiperai.ai/api/external/users', 
                      headers=headers, params=params)
data = response.json()

if data['success']:
    print(f"Showing {len(data['users'])} of {data['pagination']['total']} users")
    for user in data['users']:
        print(f"{user['name']} ({user['email']}) - {user['role']}")

卷曲

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20" \
  -H "Authorization: Bearer sk-your-api-key-here"

错误响应

401 未经授权

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

403 禁止

{
  "success": false,
  "error": "Access denied",
  "message": "Admin access required"
}

过滤示例

按姓名或电子邮件搜索

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?search=john" \
  -H "Authorization: Bearer sk-your-api-key-here"

按角色过滤

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?role=admin" \
  -H "Authorization: Bearer sk-your-api-key-here"

按许可证过滤

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?license=Growth" \
  -H "Authorization: Bearer sk-your-api-key-here"

按状态过滤

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?status=1" \
  -H "Authorization: Bearer sk-your-api-key-here"

按上次活动排序

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?sortBy=lastActive&sortOrder=desc" \
  -H "Authorization: Bearer sk-your-api-key-here"

用例

用户管理：查看和管理系统中的所有用户
用户分析：按角色、许可证或状态分析用户分布
搜索和过滤：根据各种条件查找特定用户
管理任务：支持管理操作和报告

角色描述

管理员：具有管理控制的完整系统访问权限
用户：对聊天功能和个人知识库的标准访问
globalReader：具有查看权限的管理面板的只读访问权限

许可证说明

Essential：基本级别，每月 29,000 点
增长：具有增强功能的中层
Ultra：具有最多功能的高级层
抢先体验：具有实验功能的 Beta 层

速率限制

此端点遵循标准速率限制：

每分钟 60 个请求
每小时 1000 个请求

授权

Authorization

string

header

必填

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

查询参数

page

integer

默认值:1

Page number for pagination

必填范围: x >= 1

limit

integer

默认值:20

Number of users per page

必填范围: 1 <= x <= 100

string

Search term for name, email, or username

role

enum<string>

Filter by user role

可用选项:

admin,

user,

globalReader

license

enum<string>

Filter by user license

可用选项:

Essential,

Growth,

Ultra,

Early Access

status

enum<integer>

Filter by user status (0=inactive, 1=active)

可用选项:

0,

1

sortBy

string

默认值:createdAt

Field to sort by

sortOrder

enum<string>

默认值:desc

Sort order

可用选项:

asc,

desc

响应

List of users

success

boolean

示例:

true

users

object[]

Show child attributes

pagination

object

Show child attributes

起步与配置

模型与 AI 生成

知识库与 RAG

安全、护栏与审计

用户与访问 (IAM)

计费、配额与 Webhook

获取所有用户

获取所有用户

端点

说明

身份验证

请求

查询参数

请求示例

回应

成功响应 (200)

响应字段

用法示例

JavaScript

卷曲

错误响应

401 未经授权

403 禁止

过滤示例

按姓名或电子邮件搜索

按角色过滤

按许可证过滤

按状态过滤

按上次活动排序

用例

角色描述

许可证说明

速率限制

授权

查询参数

响应

​获取所有用户

​端点

​说明

​身份验证

​请求

​查询参数

​请求示例

​回应

​成功响应 (200)

​响应字段

​用法示例

​JavaScript

​卷曲

​错误响应

​401 未经授权

​403 禁止

​过滤示例

​按姓名或电子邮件搜索

​按角色过滤

​按许可证过滤

​按状态过滤

​按上次活动排序

​用例

​角色描述

​许可证说明

​速率限制

授权

查询参数

响应

获取所有用户

端点

说明

身份验证

请求

查询参数

请求示例

回应

成功响应 (200)

响应字段

用法示例

JavaScript

卷曲

错误响应

401 未经授权

403 禁止

过滤示例

按姓名或电子邮件搜索

按角色过滤

按许可证过滤

按状态过滤

按上次活动排序

用例

角色描述

许可证说明

速率限制