Yunqi (ClickZetta / Singdata Lakehouse)

Yunqi (ClickZetta / Singdata Lakehouse) User Management API

用户管理

GitHub OpenAPI

Operations 5

POST /openapi/v2/users/create Create a user (新增) #
POST /openapi/v2/users/update Update a user (更新) #
POST /openapi/v2/users/disable Disable a user (禁用) #
POST /openapi/v2/users/enable Enable a user (启用) #
POST /openapi/v2/users/delete Delete a user (删除) #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/yunqi/openapi/yunqi-user-management-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/yunqi:yunqi-user-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yunqi-user-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ClickZetta Open Platform User Management API
  description: 'ClickZetta 开放平台管理接口，覆盖调度任务、数据源、库表同步、虚拟集群、工作空间、实时任务、实例、数据质量及用户管理。接口路径使用 /openapi/v2；info.version 保留仓库原有的契约版本标记。


    使用 AK/SK 自定义请求签名认证。accessKey 是 Access Key ID，sign 是每次请求动态生成的签名；Access Key Secret 只在客户端参与签名，不随请求发送。请求头与查询参数由官方 SDK 生成。SDK 使用 HMAC-SHA1 计算签名，查询参数 SignatureMethod 为 HMAC-SHA1，请求头 signMethod 为 HMAC-SHA256；请按 SDK 的现有协议传值，不要自行统一这两个标记。普通 OpenAPI 客户端不会自动生成此签名，建议使用官方 SDK。


    HTTP 200 只表示 HTTP 请求已返回；调用方还应检查响应中的业务结果字段。不同接口的成功及错误响应以各自模型和示例为准。'
  version: 1.0.0
servers:
- url: https://api.clickzetta.com
  description: 国内生产环境（在线文档示例）
- url: https://api.singdata.com
  description: 新加坡节点（在线文档示例）
security:
- AccessKeyID: []
  RequestSignature: []
tags:
- name: User Management
  description: 用户管理
paths:
  /openapi/v2/users/create:
    post:
      summary: Create a user (新增)
      deprecated: false
      description: 'Creates a user in the caller''s account via the downstream `addUser` operation. `name` and `phone` are required. `realName` and `displayName` default to `name` when omitted; `status` and `type` default to `0` (active / normal user). When supplied, `encryptedPassword` must contain the RSA-encrypted password.


        调用者身份上下文由公网网关根据认证信息注入，客户端无需传入 X-Gw-Context。'
      operationId: createUser
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
            examples:
              minimal:
                value:
                  name: alice_test
                  phone: '13800000000'
                summary: Minimal request (name + phone)
                description: ' 仓库提供的文档示例；本次未执行该业务调用。'
              full:
                value:
                  name: alice_test
                  realName: Alice
                  displayName: Alice A.
                  email: alice@example.com
                  phone: '13800000000'
                  type: 0
                  encryptedPassword: <RSA_ENCRYPTED_BASE64>
                summary: Full request with password
                description: ' 仓库提供的文档示例；本次未执行该业务调用。'
        required: true
      responses:
        '200':
          description: Standard envelope. On success `data` is the new user id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleResponseLong'
              examples:
                success:
                  summary: success
                  value:
                    requestId: curl-test-1
                    success: true
                    code: '200'
                    message: null
                    data: 2160238
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
                missingField:
                  summary: Missing required field
                  value:
                    requestId: curl-test-1
                    success: false
                    code: CZS-63400
                    message: 'missing required field: phone'
                    data: null
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
                downstreamError:
                  summary: Downstream failure (code preserved as suffix)
                  value:
                    requestId: curl-test-1
                    success: false
                    code: CZS-6310016
                    message: 'Create user failed: ...'
                    data: null
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
          headers: {}
  /openapi/v2/users/update:
    post:
      summary: Update a user (更新)
      deprecated: false
      description: 'Updates an existing user via the downstream `updateUser` operation. `id` (the target user id) is required; `accountId` is taken from the request context. Returns `true` on success.


        调用者身份上下文由公网网关根据认证信息注入，客户端无需传入 X-Gw-Context。'
      operationId: updateUser
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
            examples:
              update:
                value:
                  id: 2160238
                  displayName: Alice (updated)
                  email: alice2@example.com
                  status: 0
                summary: update
                description: ' 仓库提供的文档示例；本次未执行该业务调用。'
        required: true
      responses:
        '200':
          description: Standard envelope. On success `data` is `true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleResponseBoolean'
              examples:
                success:
                  summary: success
                  value:
                    requestId: curl-test-1
                    success: true
                    code: '200'
                    message: null
                    data: true
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
          headers: {}
  /openapi/v2/users/disable:
    post:
      summary: Disable a user (禁用)
      deprecated: false
      description: 'Disables (stops) a user via the downstream `stopUser` operation. A caller cannot disable their own account (self-protection): if the target `id` equals the caller''s `userId`, the request is rejected and no downstream call is made. Returns `true` on success.


        调用者身份上下文由公网网关根据认证信息注入，客户端无需传入 X-Gw-Context。'
      operationId: disableUser
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserIdRequest'
            examples:
              disable:
                value:
                  id: 2160238
                summary: disable
                description: ' 仓库提供的文档示例；本次未执行该业务调用。'
        required: true
      responses:
        '200':
          description: Standard envelope. On success `data` is `true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleResponseBoolean'
              examples:
                success:
                  summary: success
                  value:
                    requestId: curl-test-1
                    success: true
                    code: '200'
                    message: null
                    data: true
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
                selfProtection:
                  summary: Cannot act on own account
                  value:
                    requestId: curl-test-1
                    success: false
                    code: CZS-63400
                    message: cannot disable your own account
                    data: null
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
          headers: {}
  /openapi/v2/users/enable:
    post:
      summary: Enable a user (启用)
      deprecated: false
      description: 'Enables (restarts) a previously disabled user via the downstream `startUser` operation. Self-protection applies (a caller cannot enable their own account). Returns `true` on success.


        调用者身份上下文由公网网关根据认证信息注入，客户端无需传入 X-Gw-Context。'
      operationId: enableUser
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserIdRequest'
            examples:
              enable:
                value:
                  id: 2160238
                summary: enable
                description: ' 仓库提供的文档示例；本次未执行该业务调用。'
        required: true
      responses:
        '200':
          description: Standard envelope. On success `data` is `true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleResponseBoolean'
              examples:
                success:
                  summary: success
                  value:
                    requestId: curl-test-1
                    success: true
                    code: '200'
                    message: null
                    data: true
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
          headers: {}
  /openapi/v2/users/delete:
    post:
      summary: Delete a user (删除)
      deprecated: false
      description: 'Deletes a user via the downstream `deleteUser` operation. Self-protection applies (a caller cannot delete their own account). Returns `true` on success.


        调用者身份上下文由公网网关根据认证信息注入，客户端无需传入 X-Gw-Context。'
      operationId: deleteUser
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserIdRequest'
            examples:
              delete:
                value:
                  id: 2160238
                summary: delete
                description: ' 仓库提供的文档示例；本次未执行该业务调用。'
        required: true
      responses:
        '200':
          description: Standard envelope. On success `data` is `true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleResponseBoolean'
              examples:
                success:
                  summary: success
                  value:
                    requestId: curl-test-1
                    success: true
                    code: '200'
                    message: null
                    data: true
                  description: ' 仓库提供的文档示例；本次未执行该业务调用。'
          headers: {}
components:
  schemas:
    Response:
      type: object
      description: Common response envelope fields.
      properties:
        requestId:
          type:
          - string
          - 'null'
          description: Echo of the requestId parsed from Gw_Context.
          example: curl-test-1
        success:
          type: boolean
          description: True on success, false on any failure.
        code:
          type: string
          description: '"200" on success; on failure the user error prefix `CZS-63` concatenated with a suffix (400/500) or the downstream code.

            '
          example: '200'
        message:
          type:
          - string
          - 'null'
          description: Failure detail; null/absent on success.
      title: Response
    UserCreateRequest:
      type: object
      required:
      - name
      - phone
      properties:
        name:
          type: string
          description: Login/user name. Required.
          example: alice_test
        realName:
          type: string
          description: Real name. Defaults to `name` when omitted.
          example: Alice
        displayName:
          type: string
          description: Display name. Defaults to `name` when omitted.
          example: Alice A.
        email:
          type: string
          description: Email address (optional).
          example: alice@example.com
        phone:
          type: string
          description: Phone number. Required (NOT NULL downstream).
          example: '13800000000'
        title:
          type: string
          description: 'Job title. Accepted but not currently persisted downstream (the resolved account-api model has no setter for it).

            '
        comment:
          type: string
          description: 'Remark. Accepted but not currently persisted downstream (the resolved account-api model has no setter for it).

            '
        status:
          type: integer
          format: int32
          description: User status (tinyint). Defaults to 0 (active) when omitted.
          example: 0
        type:
          type: integer
          format: int32
          description: User type (tinyint). Defaults to 0 (normal user) when omitted.
          example: 0
        encryptedPassword:
          type: string
          description: 'RSA-encrypted (Base64) raw password. Decrypted with the configured private key, then stored as a salted MD5 hash. Optional.

            '
        credentialId:
          type: string
          description: 'Credential id. Accepted but not currently persisted downstream (the resolved account-api model has no compatible setter).

            '
      title: UserCreateRequest
    UserIdRequest:
      type: object
      required:
      - id
      properties:
        id:
          type: integer
          format: int64
          description: Target user id. Required.
          example: 2160238
      title: UserIdRequest
    SingleResponseBoolean:
      allOf:
      - $ref: '#/components/schemas/Response'
      - type: object
        properties:
          data:
            type:
            - boolean
            - 'null'
            description: true on success; null on failure.
      title: SingleResponseBoolean
    SingleResponseLong:
      allOf:
      - $ref: '#/components/schemas/Response'
      - type: object
        properties:
          data:
            type:
            - integer
            - 'null'
            format: int64
            description: New user id on success; null on failure.
            example: 2160238
      title: SingleResponseLong
    UserUpdateRequest:
      type: object
      required:
      - id
      properties:
        id:
          type: integer
          format: int64
          description: Target user id. Required.
          example: 2160238
        name:
          type: string
        realName:
          type: string
        displayName:
          type: string
        email:
          type: string
        phone:
          type: string
        title:
          type: string
          description: Accepted but not persisted downstream.
        comment:
          type: string
          description: Accepted but not persisted downstream.
        status:
          type: integer
          format: int32
          description: User status (tinyint).
        type:
          type: integer
          format: int32
          description: User type (tinyint).
      title: UserUpdateRequest
  parameters:
    AuthQuerySignatureMethod:
      name: SignatureMethod
      in: query
      required: false
      description: SDK 查询参数声明使用 HMAC-SHA1。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - HMAC-SHA1
      x-sdk-injected: true
    AuthHeaderSignVersion:
      name: signVersion
      in: header
      required: false
      description: SDK 写入签名版本。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - v1.0
      x-sdk-injected: true
    AuthQuerySignature:
      name: Signature
      in: query
      required: false
      description: SDK 计算的 Base64 签名，同请求头 sign。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthQueryTimestamp:
      name: Timestamp
      in: query
      required: false
      description: SDK 生成 UTC 时间戳；签名和 URL 序列化包含百分号编码，具体规则以附件 SDK 为准。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthHeaderNonce:
      name: nonce
      in: header
      required: false
      description: SDK 生成的随机数字串，与 SignatureNonce 一致。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthHeaderMethod:
      name: method
      in: header
      required: false
      description: SDK 写入 HTTP 方法。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - POST
      x-sdk-injected: true
    AuthHeaderT:
      name: t
      in: header
      required: false
      description: SDK 写入当前 Unix 毫秒时间戳的十进制字符串。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthQuerySignatureNonce:
      name: SignatureNonce
      in: query
      required: false
      description: SDK 生成的随机数字串。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthQuerySignatureVersion:
      name: SignatureVersion
      in: query
      required: false
      description: SDK 查询参数签名版本。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - '1.0'
      x-sdk-injected: true
    AuthHeaderSignMethod:
      name: signMethod
      in: header
      required: false
      description: SDK 请求头协议标记，固定为 HMAC-SHA256；实际签名计算及查询参数按 SDK 使用 HMAC-SHA1。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - HMAC-SHA256
      x-sdk-injected: true
    AuthQueryFormat:
      name: Format
      in: query
      required: false
      description: SDK 固定输出 JSON。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - JSON
      x-sdk-injected: true
  securitySchemes:
    AccessKeyID:
      type: apiKey
      in: header
      name: accessKey
      description: Access Key ID。与 RequestSignature 同时使用；不要填写 Access Key Secret。
    RequestSignature:
      type: apiKey
      in: header
      name: sign
      description: 使用 AK/SK 自定义请求签名认证。accessKey 是 Access Key ID，sign 是每次请求动态生成的签名；Access Key Secret 只在客户端参与签名，不随请求发送。请求头与查询参数由官方 SDK 生成。SDK 使用 HMAC-SHA1 计算签名，查询参数 SignatureMethod 为 HMAC-SHA1，请求头 signMethod 为 HMAC-SHA256；请按 SDK 的现有协议传值，不要自行统一这两个标记。普通 OpenAPI 客户端不会自动生成此签名，建议使用官方 SDK。
externalDocs:
  description: ClickZetta 官方文档
  url: https://yunqi.tech/documents