组织管理

概述

组织端点公开了限定每个设备、项目和令牌的租户。使用这些 API 读取有关活跃组织的元数据或重命名它。令牌创建、成员管理和访问配置在下面引用的专用指南中有说明。

• 基础路径: /api/v2/organization/
• 相关指南: 组织令牌

端点摘要

方法	路径	描述	备注
GET	/api/v2/organization/	获取附加到当前令牌或会话的活跃组织	见获取当前组织。
PUT	/api/v2/organization/	更新组织配置文件字段	见更新组织。

端点

获取当前组织

从请求上下文中解析组织的元数据。

请求

GET /api/v2/organization/
Authorization: Bearer <token>
Content-Type: application/json

响应

{
    "slug": "yengear",
    "name": "YenGear Lab",
    "description": "温室监控试点安装",
    "created_at": "2024-01-08T10:00:00Z",
    "updated_at": "2024-02-16T09:00:00Z"
}

说明

1. 组织由中间件解析。在 URL 中嵌入 slug 的应用程序仍必须传递适当的访问令牌。

更新组织

更新活跃组织的可变元数据。只有创建者（所有者）可以调用此端点。

请求

PUT /api/v2/organization/
Authorization: Bearer <owner_token>
Content-Type: application/json

{
    "name": "YenGear 智慧农业",
    "description": "温室和冷链项目的中央租户"
}

字段	类型	必填	描述
name	string	否	在门户中显示的显示名称
description	string	否	操作员的更丰富上下文。不渲染 Markdown。

响应

返回与获取当前组织相同的架构，包含更新的时间戳和值。

错误代码

状态	代码	描述
401	UNAUTHORIZED	缺少或无效的凭据
403	FORBIDDEN	调用者不是组织所有者
400	BAD_REQUEST	验证失败（例如，名称太长）

相关主题

• 成员管理、slug 更改和删除由 YenGear IoT Cloud 支持处理。如果您需要这些工作流程，请通过支持渠道联系。
• 令牌生命周期操作在组织令牌管理中说明。