组织
获取可用组织列表
返回与请求中的 API 密钥关联的单个组织的列表。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations |
请求
响应
响应模式
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一的组织 ID。 |
| createdAt | 日期时间 | 创建组织的时间戳。ISO-8601。 |
| 名称 | 字符串 | 组织的名称。 |
| privateEndpoints | 数组 | 组织的私有端点列表 |
示例响应
{
"id": "uuid",
"createdAt": "date-time",
"name": "string",
"privateEndpoints": "Array"
}
获取组织详细信息
返回单个组织的详细信息。为了获取详细信息，身份验证密钥必须属于该组织。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId} |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织的 ID。 |
响应
响应模式
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一的组织 ID。 |
| createdAt | 日期时间 | 创建组织的时间戳。ISO-8601。 |
| 名称 | 字符串 | 组织的名称。 |
| privateEndpoints | 数组 | 组织的私有端点列表 |
示例响应
{
"id": "uuid",
"createdAt": "date-time",
"name": "string",
"privateEndpoints": "Array"
}
更新组织详细信息
更新组织字段。需要管理员身份验证密钥角色。
| 方法 | 路径 |
|---|---|
| PATCH | /v1/organizations/{organizationId} |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 要更新的组织的 ID。 |
主体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| 名称 | 字符串 | 组织的名称。 |
| privateEndpoints |
响应
响应模式
| 名称 | 类型 | 描述 |
|---|---|---|
| id | uuid | 唯一的组织 ID。 |
| createdAt | 日期时间 | 创建组织的时间戳。ISO-8601。 |
| 名称 | 字符串 | 组织的名称。 |
| privateEndpoints | 数组 | 组织的私有端点列表 |
示例响应
{
"id": "uuid",
"createdAt": "date-time",
"name": "string",
"privateEndpoints": "Array"
}
组织活动列表
返回所有组织活动的列表。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/activities |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织的 ID。 |
| from_date | 日期时间 | 搜索的起始日期 |
| to_date | 日期时间 | 搜索的结束日期 |
响应
响应模式
| 名称 | 类型 | 描述 |
|---|---|---|
| id | 字符串 | 唯一的活动 ID。 |
| createdAt | 日期时间 | 活动的日期时间戳。ISO-8601。 |
| 类型 | 字符串 | 活动的类型。 |
| actorType | 字符串 | 参与者的类型：'user'、'support'、'system'、'api'。 |
| actorId | 字符串 | 唯一的参与者 ID。 |
| actorDetails | 字符串 | 关于参与者的附加信息。 |
| actorIpAddress | 字符串 | 参与者的 IP 地址。为 'user' 和 'api' 参与者类型定义。 |
| organizationId | 字符串 | 活动的范围：此活动相关的组织 ID。 |
| serviceId | 字符串 | 活动的范围：此活动相关的服务 ID。 |
示例响应
{
"id": "string",
"createdAt": "date-time",
"type": "string",
"actorType": "string",
"actorId": "string",
"actorDetails": "string",
"actorIpAddress": "string",
"organizationId": "string",
"serviceId": "string"
}
组织活动
根据 ID 返回单个组织活动。
| 方法 | 路径 |
|---|---|
| GET | /v1/organizations/{organizationId}/activities/{activityId} |
请求
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| organizationId | uuid | 请求的组织的 ID。 |
| activityId | 字符串 | 请求的活动的 ID。 |
响应
响应模式
| 名称 | 类型 | 描述 |
|---|---|---|
| id | 字符串 | 唯一的活动 ID。 |
| createdAt | 日期时间 | 活动的日期时间戳。ISO-8601。 |
| 类型 | 字符串 | 活动的类型。 |
| actorType | 字符串 | 参与者的类型：'user'、'support'、'system'、'api'。 |
| actorId | 字符串 | 唯一的参与者 ID。 |
| actorDetails | 字符串 | 关于参与者的附加信息。 |
| actorIpAddress | 字符串 | 参与者的 IP 地址。为 'user' 和 'api' 参与者类型定义。 |
| organizationId | 字符串 | 活动的范围：此活动相关的组织 ID。 |
| serviceId | 字符串 | 活动的范围：此活动相关的服务 ID。 |
示例响应
{
"id": "string",
"createdAt": "date-time",
"type": "string",
"actorType": "string",
"actorId": "string",
"actorDetails": "string",
"actorIpAddress": "string",
"organizationId": "string",
"serviceId": "string"
}