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

4.7 KiB
Raw Blame History

ACMEUserService

ACME用户相关服务


countACMEUsers

计算用户数量

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ACMEUserService/countACMEUsers
  • RPCrpc countACMEUsers (CountAcmeUsersRequest) returns (RPCCountResponse);

请求对象 (CountAcmeUsersRequest)

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

响应对象 (RPCCountResponse)

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

调用示例

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

createACMEUser

创建用户

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ACMEUserService/createACMEUser
  • RPCrpc createACMEUser (CreateACMEUserRequest) returns (CreateACMEUserResponse);

请求对象 (CreateACMEUserRequest)

{
  "userId": "int64 // 所属用户,只有管理员才有权限指定",
  "email": "string // 用户邮箱",
  "description": "string // 用户描述",
  "acmeProviderCode": "string // 服务商代号",
  "acmeProviderAccountId": "int64 // 服务商帐号"
}

响应对象 (CreateACMEUserResponse)

{
  "acmeUserId": "int64"
}

调用示例

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

deleteACMEUser

删除用户

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ACMEUserService/deleteACMEUser
  • RPCrpc deleteACMEUser (DeleteACMEUserRequest) returns (RPCSuccess);

请求对象 (DeleteACMEUserRequest)

{
  "acmeUserId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

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

findAllACMEUsers

查找所有用户

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ACMEUserService/findAllACMEUsers
  • RPCrpc findAllACMEUsers (FindAllACMEUsersRequest) returns (FindAllACMEUsersResponse);

请求对象 (FindAllACMEUsersRequest)

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

响应对象 (FindAllACMEUsersResponse)

{
  "acmeUsers": "[]ACMEUser"
}

调用示例

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

findEnabledACMEUser

查找单个用户

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ACMEUserService/findEnabledACMEUser
  • RPCrpc findEnabledACMEUser (FindEnabledACMEUserRequest) returns (FindEnabledACMEUserResponse);

请求对象 (FindEnabledACMEUserRequest)

{
  "acmeUserId": "int64"
}

响应对象 (FindEnabledACMEUserResponse)

{
  "acmeUser": "ACMEUser"
}

调用示例

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

listACMEUsers

列出单页用户

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ACMEUserService/listACMEUsers
  • RPCrpc listACMEUsers (ListACMEUsersRequest) returns (ListACMEUsersResponse);

请求对象 (ListACMEUsersRequest)

{
  "adminId": "int64 // 管理员ID",
  "userId": "int64 // 用户ID",
  "offset": "int64 // 读取位置",
  "size": "int64 // 数量通常不能小于0"
}

响应对象 (ListACMEUsersResponse)

{
  "acmeUsers": "[]ACMEUser"
}

调用示例

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

updateACMEUser

修改用户

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ACMEUserService/updateACMEUser
  • RPCrpc updateACMEUser (UpdateACMEUserRequest) returns (RPCSuccess);

请求对象 (UpdateACMEUserRequest)

{
  "acmeUserId": "int64",
  "description": "string // 描述(备注)"
}

响应对象 (RPCSuccess)

{}

调用示例

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