Lattice.Hub
GitHub

Lattice Hub 文档
HTTP OpenAPI鉴权

用户组

用户组 CRUD 与 Token 管理。

用户组 CRUD 与 Token 管理。

默认 Base URL：http://127.0.0.1:8090。管理面接口需 Authorization（登录返回的 token）。

鉴权 · 用户组

用户组 CRUD 与 Token 管理。

GET/auth/v1/usergroups需要鉴权

查询用户组

查询用户组。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idquery · string可选

    id

  • namequery · string可选

    name

  • user_idquery · string可选

    user_id

  • offsetquery · integer可选

    offset

  • limitquery · integer可选

    limit

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/usergroups' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/usergroups需要鉴权

创建用户组

创建用户组。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · UserGroup[]必填

    请求体为 UserGroup 的 JSON 数组；下列为单条字段。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • auth_tokenbody · string可选

    auth_token

  • token_enablebody · bool可选

    token_enable

  • commentbody · string可选

    comment

  • relationbody · UserGroupRelation可选

    relation

    • group_idbody · string可选

      group_id

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

  • user_countbody · uint32可选

    user_count

  • sourcebody · string可选

    source

  • metadatabody · map<string,string>可选

    metadata

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • UserGroupbody · UserGroup可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • ctimebody · string可选

          ctime

        • mtimebody · string可选

          mtime

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/usergroups' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/usergroups需要鉴权

更新用户组

更新用户组。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · UserGroup[]必填

    请求体为 UserGroup 的 JSON 数组；下列为单条字段。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • auth_tokenbody · string可选

    auth_token

  • token_enablebody · bool可选

    token_enable

  • commentbody · string可选

    comment

  • relationbody · UserGroupRelation可选

    relation

    • group_idbody · string可选

      group_id

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

  • user_countbody · uint32可选

    user_count

  • sourcebody · string可选

    source

  • metadatabody · map<string,string>可选

    metadata

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • UserGroupbody · UserGroup可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • ctimebody · string可选

          ctime

        • mtimebody · string可选

          mtime

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

请求示例
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/usergroups' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/usergroups/delete需要鉴权

删除用户组

删除用户组。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · UserGroup[]必填

    请求体为 UserGroup 的 JSON 数组；下列为单条字段。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • auth_tokenbody · string可选

    auth_token

  • token_enablebody · bool可选

    token_enable

  • commentbody · string可选

    comment

  • relationbody · UserGroupRelation可选

    relation

    • group_idbody · string可选

      group_id

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

  • user_countbody · uint32可选

    user_count

  • sourcebody · string可选

    source

  • metadatabody · map<string,string>可选

    metadata

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • UserGroupbody · UserGroup可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • ctimebody · string可选

          ctime

        • mtimebody · string可选

          mtime

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/usergroups/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/auth/v1/usergroup/detail需要鉴权

用户组详情

用户组详情。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idquery · string必填

    id

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/usergroup/detail' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/auth/v1/usergroup/token需要鉴权

获取用户组 Token

获取用户组 Token。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idquery · string必填

    id

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/usergroup/token' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/usergroup/token/enable需要鉴权

启用/禁用用户组 Token

启用/禁用用户组 Token。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • auth_tokenbody · string可选

    auth_token

  • token_enablebody · bool可选

    token_enable

  • commentbody · string可选

    comment

  • relationbody · UserGroupRelation可选

    relation

    • group_idbody · string可选

      group_id

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

  • user_countbody · uint32可选

    user_count

  • sourcebody · string可选

    source

  • metadatabody · map<string,string>可选

    metadata

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • UserGroupbody · UserGroup可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • ctimebody · string可选

          ctime

        • mtimebody · string可选

          mtime

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

请求示例
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/usergroup/token/enable' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/usergroup/token/refresh需要鉴权

刷新用户组 Token

刷新用户组 Token。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • auth_tokenbody · string可选

    auth_token

  • token_enablebody · bool可选

    token_enable

  • commentbody · string可选

    comment

  • relationbody · UserGroupRelation可选

    relation

    • group_idbody · string可选

      group_id

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

  • user_countbody · uint32可选

    user_count

  • sourcebody · string可选

    source

  • metadatabody · map<string,string>可选

    metadata

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • UserGroupbody · UserGroup可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • ctimebody · string可选

          ctime

        • mtimebody · string可选

          mtime

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

请求示例
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/usergroup/token/refresh' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}

用户

用户 CRUD 与 Token / 密码管理。

角色

角色 CRUD。

On this page

GET 查询用户组POST 创建用户组PUT 更新用户组POST 删除用户组GET 用户组详情GET 获取用户组 TokenPUT 启用/禁用用户组 TokenPUT 刷新用户组 Token