切换深色模式
登录与内部服务 API
本页列出当前版本的完整方法及字段。方法通过 gRPC / gRPC-Web 调用；REST 注解不表示已部署 REST Gateway。
“必填：按业务校验”表示 proto3 未声明 required，不代表留空一定可用。UUID、EUI、权限、资源存在性与字段组合由服务端校验。嵌套结构详见页末消息结构。
InternalService
Login
接口名称： api.InternalService/Login
功能： 登录并获取 JWT。Log in a user
请求： api.LoginRequest；返回： api.LoginResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
email | string | 按业务校验 | 登录身份 / 邮箱。 Email of the user. |
password | string | 按业务校验 | 密码。 Password of the user. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
jwt | string | 按业务校验 | 登录令牌。 The JWT tag to be used to access chirpstack-application-server interfaces. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
Profile
接口名称： api.InternalService/Profile
功能： 查询当前用户资料。Get the current user's profile
请求： google.protobuf.Empty；返回： api.ProfileResponse（单次响应）。
请求参数
无字段。
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
user | api.User | 按业务校验 | 用户对象。 User object. |
tenants | repeated api.UserTenantLink | 按业务校验 | 关联租户列表。 Tenants to which the user is associated. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GlobalSearch
接口名称： api.InternalService/GlobalSearch
功能： GlobalSearch。Perform a global search.
请求： api.GlobalSearchRequest；返回： api.GlobalSearchResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
search | string | 按业务校验 | 搜索关键字。 Search query. |
limit | int64 | 按业务校验 | 本次最多返回条数。 Max number of results to return. If not set, it will be treated as 0, and the response will only return the total_count. |
offset | int64 | 按业务校验 | 分页起始偏移。 Offset offset of the result-set (for pagination). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
result | repeated api.GlobalSearchResult | 按业务校验 | 结果列表或结果内容。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
CreateApiKey
接口名称： api.InternalService/CreateApiKey
功能： 创建 ApiKey。CreateApiKey creates the given API key.
请求： api.CreateApiKeyRequest；返回： api.CreateApiKeyResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
api_key | api.ApiKey | 按业务校验 | 接口密钥属性。 The API key to create. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 API key ID. |
token | string | 按业务校验 | API 调用令牌。 API token for authentication API requests. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
DeleteApiKey
接口名称： api.InternalService/DeleteApiKey
功能： 删除 ApiKey。DeleteApiKey deletes the API key.
请求： api.DeleteApiKeyRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 API key ID. |
返回值
无字段。
操作影响
此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ListApiKeys
接口名称： api.InternalService/ListApiKeys
功能： 列出 ApiKeys。ListApiKeys lists the available API keys.
请求： api.ListApiKeysRequest；返回： api.ListApiKeysResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of items to return. If not set, it will be treated as 0, and the response will only return the total_count. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set (for pagination). |
is_admin | bool | 按业务校验 | 平台或当前资源范围管理员标志。 Return only admin keys. |
tenant_id | string | 按业务校验 | 租户 UUID。 Filter on tenant ID. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 Total number of API keys. |
result | repeated api.ApiKey | 按业务校验 | 结果列表或结果内容。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
Settings
接口名称： api.InternalService/Settings
功能： Settings。Get the global settings.
请求： google.protobuf.Empty；返回： api.SettingsResponse（单次响应）。
请求参数
无字段。
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
openid_connect | api.OpenIdConnect | 按业务校验 | OpenId Connect settings. |
oauth2 | api.OAuth2 | 按业务校验 | OAuth2 settings. |
tileserver_url | string | 按业务校验 | Tileserver URL. |
map_attribution | string | 按业务校验 | Map attribution. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
OpenIdConnectLogin
接口名称： api.InternalService/OpenIdConnectLogin
功能： OpenIdConnectLogin。OpenId Connect login.
请求： api.OpenIdConnectLoginRequest；返回： api.OpenIdConnectLoginResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | string | 按业务校验 | 代码。 OpenId Connect callback code. |
state | string | 按业务校验 | OpenId Connect callback state. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 按业务校验 | API 调用令牌。 Token to use for authentication. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
OAuth2Login
接口名称： api.InternalService/OAuth2Login
功能： OAuth2Login。OAuth2 login.
请求： api.OAuth2LoginRequest；返回： api.OAuth2LoginResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | string | 按业务校验 | 代码。 OAuth2 callback code. |
state | string | 按业务校验 | OAuth2 callback state. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 按业务校验 | API 调用令牌。 Token to use for authentication. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetDevicesSummary
接口名称： api.InternalService/GetDevicesSummary
功能： 查询 DevicesSummary。GetDevicesSummary returns an aggregated summary of the devices.
请求： api.GetDevicesSummaryRequest；返回： api.GetDevicesSummaryResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID (UUID). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
active_count | uint32 | 按业务校验 | Active count. |
inactive_count | uint32 | 按业务校验 | Inactive count. |
dr_count | map<uint32, uint32> | 按业务校验 | per data-rate count. Devices that have never been seen are excluded. |
never_seen_count | uint32 | 按业务校验 | Never seen count. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetGatewaysSummary
接口名称： api.InternalService/GetGatewaysSummary
功能： 查询 GatewaysSummary。GetGatewaysSummary returns an aggregated summary of the gateways.
请求： api.GetGatewaysSummaryRequest；返回： api.GetGatewaysSummaryResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID (UUID). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
online_count | uint32 | 按业务校验 | Online count. |
offline_count | uint32 | 按业务校验 | Offline count. |
never_seen_count | uint32 | 按业务校验 | Never seen count. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
StreamGatewayFrames
接口名称： api.InternalService/StreamGatewayFrames
功能： 持续订阅网关无线帧。Stream frame for the given Gateway ID.
请求： api.StreamGatewayFramesRequest；返回： api.LogItem（服务端流：持续返回多条消息）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (EUI64). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
time | google.protobuf.Timestamp | 按业务校验 | 时间。 Timestamp. |
description | string | 按业务校验 | 描述。 Message. |
body | string | 按业务校验 | Body. |
properties | map<string, string> | 按业务校验 | Properties. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
StreamDeviceFrames
接口名称： api.InternalService/StreamDeviceFrames
功能： 持续订阅终端无线帧。Stream frames for the given Device EUI.
请求： api.StreamDeviceFramesRequest；返回： api.LogItem（服务端流：持续返回多条消息）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
time | google.protobuf.Timestamp | 按业务校验 | 时间。 Timestamp. |
description | string | 按业务校验 | 描述。 Message. |
body | string | 按业务校验 | Body. |
properties | map<string, string> | 按业务校验 | Properties. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
StreamDeviceEvents
接口名称： api.InternalService/StreamDeviceEvents
功能： 持续订阅终端应用事件。Stream events for the given Device EUI.
请求： api.StreamDeviceEventsRequest；返回： api.LogItem（服务端流：持续返回多条消息）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
time | google.protobuf.Timestamp | 按业务校验 | 时间。 Timestamp. |
description | string | 按业务校验 | 描述。 Message. |
body | string | 按业务校验 | Body. |
properties | map<string, string> | 按业务校验 | Properties. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
StreamRuntimeStatus
接口名称： api.InternalService/StreamRuntimeStatus
功能： 持续订阅运行状态变化。Stream runtime status changes for devices and gateways in a tenant.
请求： api.StreamRuntimeStatusRequest；返回： api.RuntimeStatusEvent（服务端流：持续返回多条消息）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID. |
application_id | string | 按业务校验 | 应用 UUID。 Optional application ID filter for devices. |
include_devices | bool | 按业务校验 | Include device status events. |
include_gateways | bool | 按业务校验 | Include gateway status events. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
resource_type | string | 按业务校验 | Resource type: device or gateway. |
id | string | 按业务校验 | 资源 ID。 Device EUI or Gateway ID. |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID. |
application_id | string | 按业务校验 | 应用 UUID。 Application ID, only set for devices. |
state | string | 按业务校验 | State: online, offline, never-seen, or disabled. |
last_seen_at | google.protobuf.Timestamp | 按业务校验 | 最后上报时间。 Last seen timestamp. |
next_offline_at | google.protobuf.Timestamp | 按业务校验 | Timestamp at which the resource should be considered offline. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ListRegions
接口名称： api.InternalService/ListRegions
功能： 列出 Regions。ListRegions lists the available (configured) regions.
请求： google.protobuf.Empty；返回： api.ListRegionsResponse（单次响应）。
请求参数
无字段。
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
regions | repeated api.RegionListItem | 按业务校验 | Configured regions. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetRegion
接口名称： api.InternalService/GetRegion
功能： 查询 Region。GetRegion returns the region details for the given region.
请求： api.GetRegionRequest；返回： api.GetRegionResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 Region ID. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
region | common.Region {EU868=0, US915=2, CN779=3, EU433=4, AU915=5, CN470=6, AS923=7, AS923_2=12, AS923_3=13, AS923_4=14, KR920=8, IN865=9, RU864=10, ISM2400=11} | 按业务校验 | 区域枚举。 Region. |
user_info | string | 按业务校验 | User information. |
uplink_channels | repeated api.RegionChannel | 按业务校验 | Uplink channels. |
rx1_delay | uint32 | 按业务校验 | RX1 delay. |
rx1_dr_offset | uint32 | 按业务校验 | RX1 data-rate offset. |
rx2_dr | uint32 | 按业务校验 | RX2 DR. |
rx2_frequency | uint32 | 按业务校验 | RX2 frequency. |
class_b_ping_slot_dr | uint32 | 按业务校验 | Class-B ping-slot DR. |
class_b_ping_slot_frequency | uint32 | 按业务校验 | Class-B ping-slot frequency. |
description | string | 按业务校验 | 描述。 Region description. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetVersion
接口名称： api.InternalService/GetVersion
功能： 查询 Version。GetVersion returns the ChirpStack version.
请求： google.protobuf.Empty；返回： api.GetVersionResponse（单次响应）。
请求参数
无字段。
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
version | string | 按业务校验 | version |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
嵌套消息结构
api.ApiKey
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 API key ID. This value will be automatically generated on create. |
name | string | 按业务校验 | 名称。 Name. |
is_admin | bool | 按业务校验 | 平台或当前资源范围管理员标志。 Is global admin key. |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID. In case the API key is intended to manage resources under a single tenant. |
is_read_only | bool | 按业务校验 | 是否只读。 Is read-only. |
api.CreateApiKeyRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
api_key | api.ApiKey | 按业务校验 | 接口密钥属性。 The API key to create. |
api.CreateApiKeyResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 API key ID. |
token | string | 按业务校验 | API 调用令牌。 API token for authentication API requests. |
api.DeleteApiKeyRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 API key ID. |
api.GetDevicesSummaryRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID (UUID). |
api.GetDevicesSummaryResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
active_count | uint32 | 按业务校验 | Active count. |
inactive_count | uint32 | 按业务校验 | Inactive count. |
dr_count | map<uint32, uint32> | 按业务校验 | per data-rate count. Devices that have never been seen are excluded. |
never_seen_count | uint32 | 按业务校验 | Never seen count. |
api.GetDevicesSummaryResponse.DrCountEntry
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | uint32 | 按业务校验 | 消息定义未补充字段说明。 |
value | uint32 | 按业务校验 | 消息定义未补充字段说明。 |
api.GetGatewaysSummaryRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID (UUID). |
api.GetGatewaysSummaryResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
online_count | uint32 | 按业务校验 | Online count. |
offline_count | uint32 | 按业务校验 | Offline count. |
never_seen_count | uint32 | 按业务校验 | Never seen count. |
api.GetRegionRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 Region ID. |
api.GetRegionResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
region | common.Region {EU868=0, US915=2, CN779=3, EU433=4, AU915=5, CN470=6, AS923=7, AS923_2=12, AS923_3=13, AS923_4=14, KR920=8, IN865=9, RU864=10, ISM2400=11} | 按业务校验 | 区域枚举。 Region. |
user_info | string | 按业务校验 | User information. |
uplink_channels | repeated api.RegionChannel | 按业务校验 | Uplink channels. |
rx1_delay | uint32 | 按业务校验 | RX1 delay. |
rx1_dr_offset | uint32 | 按业务校验 | RX1 data-rate offset. |
rx2_dr | uint32 | 按业务校验 | RX2 DR. |
rx2_frequency | uint32 | 按业务校验 | RX2 frequency. |
class_b_ping_slot_dr | uint32 | 按业务校验 | Class-B ping-slot DR. |
class_b_ping_slot_frequency | uint32 | 按业务校验 | Class-B ping-slot frequency. |
description | string | 按业务校验 | 描述。 Region description. |
api.GetVersionResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
version | string | 按业务校验 | version |
api.GlobalSearchRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
search | string | 按业务校验 | 搜索关键字。 Search query. |
limit | int64 | 按业务校验 | 本次最多返回条数。 Max number of results to return. If not set, it will be treated as 0, and the response will only return the total_count. |
offset | int64 | 按业务校验 | 分页起始偏移。 Offset offset of the result-set (for pagination). |
api.GlobalSearchResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
result | repeated api.GlobalSearchResult | 按业务校验 | 结果列表或结果内容。 |
api.GlobalSearchResult
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
kind | string | 按业务校验 | Record kind. |
score | float | 按业务校验 | Search score. |
tenant_id | string | 按业务校验 | 租户 UUID。 Organization id. |
tenant_name | string | 按业务校验 | Organization name. |
application_id | string | 按业务校验 | 应用 UUID。 Application id. |
application_name | string | 按业务校验 | Application name. |
device_dev_eui | string | 按业务校验 | Device DevEUI (hex encoded). |
device_name | string | 按业务校验 | Device name. |
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway MAC (hex encoded). |
gateway_name | string | 按业务校验 | Gateway name. |
api.ListApiKeysRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of items to return. If not set, it will be treated as 0, and the response will only return the total_count. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set (for pagination). |
is_admin | bool | 按业务校验 | 平台或当前资源范围管理员标志。 Return only admin keys. |
tenant_id | string | 按业务校验 | 租户 UUID。 Filter on tenant ID. |
api.ListApiKeysResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 Total number of API keys. |
result | repeated api.ApiKey | 按业务校验 | 结果列表或结果内容。 |
api.ListRegionsResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
regions | repeated api.RegionListItem | 按业务校验 | Configured regions. |
api.LogItem
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
time | google.protobuf.Timestamp | 按业务校验 | 时间。 Timestamp. |
description | string | 按业务校验 | 描述。 Message. |
body | string | 按业务校验 | Body. |
properties | map<string, string> | 按业务校验 | Properties. |
api.LogItem.PropertiesEntry
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | 按业务校验 | 消息定义未补充字段说明。 |
value | string | 按业务校验 | 消息定义未补充字段说明。 |
api.LoginRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
email | string | 按业务校验 | 登录身份 / 邮箱。 Email of the user. |
password | string | 按业务校验 | 密码。 Password of the user. |
api.LoginResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
jwt | string | 按业务校验 | 登录令牌。 The JWT tag to be used to access chirpstack-application-server interfaces. |
api.OAuth2
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
enabled | bool | 按业务校验 | OAuth2 is enabled. |
login_url | string | 按业务校验 | Login url. |
login_label | string | 按业务校验 | Login label. |
logout_url | string | 按业务校验 | Logout url. |
login_redirect | bool | 按业务校验 | Login redirect. |
api.OAuth2LoginRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | string | 按业务校验 | 代码。 OAuth2 callback code. |
state | string | 按业务校验 | OAuth2 callback state. |
api.OAuth2LoginResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 按业务校验 | API 调用令牌。 Token to use for authentication. |
api.OpenIdConnect
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
enabled | bool | 按业务校验 | Enable OpenId Connect authentication. |
login_url | string | 按业务校验 | Login url. |
login_label | string | 按业务校验 | Login label. |
logout_url | string | 按业务校验 | Logout url. |
login_redirect | bool | 按业务校验 | Login redirect. |
api.OpenIdConnectLoginRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | string | 按业务校验 | 代码。 OpenId Connect callback code. |
state | string | 按业务校验 | OpenId Connect callback state. |
api.OpenIdConnectLoginResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 按业务校验 | API 调用令牌。 Token to use for authentication. |
api.ProfileResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
user | api.User | 按业务校验 | 用户对象。 User object. |
tenants | repeated api.UserTenantLink | 按业务校验 | 关联租户列表。 Tenants to which the user is associated. |
api.RegionChannel
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
frequency | uint32 | 按业务校验 | 频率。 Frequency (Hz). |
data_rates | repeated uint32 | 按业务校验 | Data-rates. |
api.RegionListItem
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
region | common.Region {EU868=0, US915=2, CN779=3, EU433=4, AU915=5, CN470=6, AS923=7, AS923_2=12, AS923_3=13, AS923_4=14, KR920=8, IN865=9, RU864=10, ISM2400=11} | 按业务校验 | 区域枚举。 Region. |
description | string | 按业务校验 | 描述。 Description. |
api.RuntimeStatusEvent
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
resource_type | string | 按业务校验 | Resource type: device or gateway. |
id | string | 按业务校验 | 资源 ID。 Device EUI or Gateway ID. |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID. |
application_id | string | 按业务校验 | 应用 UUID。 Application ID, only set for devices. |
state | string | 按业务校验 | State: online, offline, never-seen, or disabled. |
last_seen_at | google.protobuf.Timestamp | 按业务校验 | 最后上报时间。 Last seen timestamp. |
next_offline_at | google.protobuf.Timestamp | 按业务校验 | Timestamp at which the resource should be considered offline. |
api.SettingsResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
openid_connect | api.OpenIdConnect | 按业务校验 | OpenId Connect settings. |
oauth2 | api.OAuth2 | 按业务校验 | OAuth2 settings. |
tileserver_url | string | 按业务校验 | Tileserver URL. |
map_attribution | string | 按业务校验 | Map attribution. |
api.StreamDeviceEventsRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI. |
api.StreamDeviceFramesRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI. |
api.StreamGatewayFramesRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (EUI64). |
api.StreamRuntimeStatusRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID. |
application_id | string | 按业务校验 | 应用 UUID。 Optional application ID filter for devices. |
include_devices | bool | 按业务校验 | Include device status events. |
include_gateways | bool | 按业务校验 | Include gateway status events. |
api.User
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 User ID (UUID). Will be set automatically on create. |
is_admin | bool | 按业务校验 | 平台或当前资源范围管理员标志。 Set to true to make the user a global administrator. |
is_active | bool | 按业务校验 | 是否启用。 Set to false to disable the user. |
email | string | 按业务校验 | 登录身份 / 邮箱。 E-mail of the user. |
note | string | 按业务校验 | 备注。 Optional note to store with the user. |
api.UserTenantLink
Defines a tenant to which the user is associated.
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
created_at | google.protobuf.Timestamp | 按业务校验 | 创建时间。 Created at timestamp. |
updated_at | google.protobuf.Timestamp | 按业务校验 | 最后更新时间。 Last update timestamp. |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID. |
is_admin | bool | 按业务校验 | 平台或当前资源范围管理员标志。 User is admin within the context of this tenant. There is no need to set the is_device_admin and is_gateway_admin flags. |
is_device_admin | bool | 按业务校验 | User is able to modify device related resources (applications, device-profiles, devices, multicast-groups). |
is_gateway_admin | bool | 按业务校验 | User is able to modify gateways. |