Files
pyGoEdge-UserPanel/reference/goedge 文档/UserAccessKeyService.md
2025-11-18 03:36:49 +08:00

3.6 KiB
Raw Permalink Blame History

UserAccessKeyService

用户AccessKey相关服务


countAllEnabledUserAccessKeys

计算AccessKey数量

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserAccessKeyService/countAllEnabledUserAccessKeys
  • RPCrpc countAllEnabledUserAccessKeys (CountAllEnabledUserAccessKeysRequest) returns (RPCCountResponse);

请求对象 (CountAllEnabledUserAccessKeysRequest)

{
  "adminId": "int64 // 管理员ID",
  "userId": "int64 // 用户ID"
}

响应对象 (RPCCountResponse)

{
  "count": "int64 // 数量"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserAccessKeyService/countAllEnabledUserAccessKeys" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

createUserAccessKey

创建AccessKey

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserAccessKeyService/createUserAccessKey
  • RPCrpc createUserAccessKey (CreateUserAccessKeyRequest) returns (CreateUserAccessKeyResponse);

请求对象 (CreateUserAccessKeyRequest)

{
  "userId": "int64 // 用户ID",
  "adminId": "int64 // 管理员ID",
  "description": "string // 描述(备注)"
}

响应对象 (CreateUserAccessKeyResponse)

{
  "userAccessKeyId": "int64"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserAccessKeyService/createUserAccessKey" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

deleteUserAccessKey

删除AccessKey

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserAccessKeyService/deleteUserAccessKey
  • RPCrpc deleteUserAccessKey (DeleteUserAccessKeyRequest) returns (RPCSuccess);

请求对象 (DeleteUserAccessKeyRequest)

{
  "userAccessKeyId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/UserAccessKeyService/deleteUserAccessKey" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

findAllEnabledUserAccessKeys

查找所有的AccessKey

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserAccessKeyService/findAllEnabledUserAccessKeys
  • RPCrpc findAllEnabledUserAccessKeys (FindAllEnabledUserAccessKeysRequest) returns (FindAllEnabledUserAccessKeysResponse);

请求对象 (FindAllEnabledUserAccessKeysRequest)

{
  "userId": "int64 // 用户ID",
  "adminId": "int64 // 管理员ID"
}

响应对象 (FindAllEnabledUserAccessKeysResponse)

{
  "userAccessKeys": "[]UserAccessKey"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserAccessKeyService/findAllEnabledUserAccessKeys" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateUserAccessKeyIsOn

设置是否启用AccessKey

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/UserAccessKeyService/updateUserAccessKeyIsOn
  • RPCrpc updateUserAccessKeyIsOn (UpdateUserAccessKeyIsOnRequest) returns (RPCSuccess);

请求对象 (UpdateUserAccessKeyIsOnRequest)

{
  "userAccessKeyId": "int64",
  "isOn": "bool // 是否启用"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/UserAccessKeyService/updateUserAccessKeyIsOn" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'