IDMesh APIs
    IDMesh APIs
    • IDMesh APIs
    • 使用文档
    • 管理 API
      • 用户
        • 创建用户
        • 锁定用户
        • 解锁用户
        • 批量锁定用户
        • 批量解锁用户
        • 批量重置密码
        • 编辑用户
        • 删除用户
        • 批量删除用户
        • 查询用户列表
        • 查询用户详情
        • 修改密码
        • 重置密码
        • 查询用户存储凭证列表
        • 创建用户存储凭证
        • 删除用户存储凭证
        • 登录名验证
        • 判断用户是否存在
        • 用户头像上传
        • 用户头像显示
        • 用户实名验证
        • 用户离职
        • 用户变更组织
      • 应用
        • 创建应用
        • 更新应用基本信息
        • 查询应用模板列表
        • 查询应用列表
        • 按条件查询应用
        • 按 ID 查询应用
        • 启用应用
        • 禁用应用
        • 删除应用
        • 刷新应用安全码
        • 查询应用配置信息
        • 更新应用配置
        • 禁用应用单点登录
        • 启用应用多子账号登录
        • 禁用应用多子账号登录
        • 启用应用单点登录
        • 启用应用多因素认证配置
        • 禁用应用多因素认证配置
        • 创建应用认证源
        • 删除应用认证源
        • 启用应用认证协议
        • 禁用应用认证协议
        • 重置应用认证协议密钥
        • 查询应用认证协议列表
        • 查询应用认证协议
        • 更新应用认证协议
        • 更新应用子账号
        • 创建应用子账号
        • 更新应用子账号
        • 启用应用子账号
        • 禁用应用子账号
        • 删除应用子账号
        • 按 APP ID 查询应用子账号列表
        • 按条件查询应用子账号列表
        • 按条件查询应用子账号
        • 按 ID 查询应用子账号
        • 更新应用 Logo
        • 批量创建应用子账号
      • 权限及资源
        • 权限
          • 鉴权
          • 获取权限列表
        • 授权单元 & 授权规则
          • 获取授权单元列表
          • 按 ID 查询授权单元
          • 删除授权单元
          • 批量创建授权规则
          • 更新授权规则
          • 查询授权单元下的授权规则列表
          • 查询授权规则列表
          • 批量删除授权规则
          • 查询授权单元下的授权规则列表
        • 资源 & 资源集合
          • 创建资源
          • 更新资源
          • 更新资源
          • 查询资源列表
          • 按 ID 查询资源
          • 删除资源
          • 创建资源集合
          • 更新资源集合
          • 查询资源集合列表
          • 按 ID 查询资源集合
          • 创建资源集合成员
          • 删除资源集合
          • 更新资源集合成员
          • 查询资源集合成员列表
          • 按 ID 查询资源集合成员
          • 删除资源集合成员
        • 应用授权
          • 授权应用
          • 查询已授权应用列表
        • 鉴权
        • 授权
      • 组织关系
        • 创建组织对象
        • 查询父组织节点
        • 删除组织节点
        • 获取组织关系列表
        • 修改组织关系基本信息
        • 获取组织关系基本信息
        • 删除组织关系
        • 批量添加组织成员
        • 添加组织成员
        • 编辑组织成员
        • 获取组织成员信息及其关联的组织关系列表
        • 获取组织的成员信息列表
        • 删除组织成员
        • 创建组织节点
        • 编辑组织节点
        • 删除组织子节点
        • 批量删除节点
        • 查询节点信息列表
        • 查询组织节点信息
        • 获取组织子节点列表
        • 获取组织的成员信息列表
        • 批量检查节点
        • 禁用组织节点
        • 禁用组织节点新
        • 批量从组织关系中移除用户-内部使用
        • 从组织关系中移除用户-内部使用
        • 树关联-删除节点关联
        • 树关联-创建
        • 树关联-树对象关系查询
        • 树关联-节点关系查询
        • 树关联-查询所有
        • 启用组织节点
      • 身份源
        • 获得系统支持的所有认证模板
        • 创建某个租户的认证方式信息
        • 创建某个租户的认证方式信息
        • 更新某个租户的认证方式信息
        • 更新某个租户的认证方式信息
        • 获得某个租户的认证方式信息
        • 查询某个租户的认证方式列表
        • 删除某个租户的认证方式信息
        • 删除某个租户的认证方式信息
        • 创建某个租户的身份源配置信息
        • 修改某个租户的身份源配置信息
        • 删除某个身份源配置信息
        • 获取某个租户支持的所有身份源配置
        • 按 ID 获取的身份源配置信息
      • KV 存储
        • 获取 Bucket 列表
        • 获取 Object 列表
        • 获取 Bucket 详情
        • 删除 Bucket
        • 创建 Object
        • 获取 Object 详情
        • 删除 Object
      • 定时任务
        • 查询定时任务列表
        • 查询定时任务详情
        • 创建定时任务
        • 更新定时任务
        • 删除定时任务
        • 触发定时任务
        • 挂起定时任务
        • 恢复定时任务
        • 获取预创建 ID
        • 查询子任务日志
        • 查询任务日志
        • 创建子任务
        • 回调子任务执行结果
        • 更新子任务
        • 取消任务执行
        • 查询指定定时任务的子任务列表
        • 查询子任务列表
      • 事件
        • 注册事件订阅
        • 查询已订阅事件列表
        • 删除订阅事件
        • 重置订阅事件
        • 更新订阅事件
    • BFF
      • 登录验证Thin模式
        POST
    • 数据模型
      • 编程者
        • 创建 Function
        • 编程者账号
        • Function
        • FunctionMarket
      • 组件
        • 安装包
        • 安装包
        • 组件运行时
        • 组件运行时
        • 安装包规格
        • 安装包规格
        • 组件组路由规则
        • 组件组路由规则
        • 组件组
        • 组件组
        • 日志收集选项
        • 端口描述
      • 应用
        • req
          • CreateAppReq
          • ModifyAppReq
          • ModifyAppConfigReq
          • CreateAppIDPReq
          • ModifyAppProtocol
          • CreateAppSubAccountReq
        • ret
          • ModifyAppRet
          • AppWithPage
          • EnableAppRet
          • DeleteAppRet
          • RefreshAppSecretRet
          • AppConfigRet
          • ModifyAppConfigRet
          • EnableAppProtocolRet
          • ResetAppProtocolSecretRet
          • AppSubAccountWithPage
        • 应用
        • 应用
        • App
        • 应用(单体查询)
        • 应用(单体查询)
        • 应用配置
        • 应用配置
        • AppConfig
        • 应用协议
        • AppProtocal
        • 应用子账号
        • AppSubAccount
        • AppTemplate
        • AppTemplateDoc
        • 应用模板用户已填参数
      • tree
        • CreateTreeNodeReq
        • tree_node
        • TreeNode
        • OrgRelationRet
        • CreateOrganizationReq
        • tree_user
        • TreeUser
        • core_object
        • CoreObject
        • OrganizationTree
        • ModifyOrganizationReq
        • AddNodeMembersReq
        • NodeUserPair
        • ModifyNodeMemberReq
        • AddNodeMembersRet
        • NodeMemberWithPage
        • CreateOrgRelationReq
        • DeleteNodeMemberReq
        • ModifyOrganizationNodeReq
        • BatchDeleteOrgNodeReq
      • 权限
        • entity
          • ResourceEntity
          • ResourceSetEntity
        • 权限及资源
          • VerifyReq
          • PrivilegeWithPage
        • 授权单元 & 授权规则
          • AuthUnitWithPage
          • AuthUnitRet
          • BatchCreateAuthUnitRuleReq
          • BatchDeleteAuthUnitRuleReq
        • 资源 & 资源集合
          • CreateResourceReq
          • CreateResoureRet
          • ModifyResourceReq
          • ResourceWithPage
          • ResourceEntity
          • BatchDeleteResourceReq
          • CreateResourceSetReq
          • CreateResourceSetRet
          • ModifyResourceSetReq
          • ResourceSetWithPage
          • CreateResourceSetMemberReq
          • CreateResourceSetMemberRet
          • BatchDeleteResourceSetReq
          • ModifyResourceSetMemberReq
          • ResourceSetMemberWithPage
          • BatchDeleteResourceSetMemberReq
        • 应用授权
          • BatchAuthzAppReq
        • 资源集合成员
        • ResourceSetMember
        • 资源集合
        • ResourceSet
        • 授权实体
        • IdentityObj
        • 授权规则参数
        • 授权规则参数
        • 授权规则
        • Au
        • 授权规则-资源
        • AuthUnitResouce
        • 资源
        • Resource
        • 授权规则-资源集合
        • AuthUnitResourceSet
        • 授权单元
        • AuthUnit
        • 权限
        • Privilege
        • ModifyAuthRuleReq
        • 授权应用
        • AuthzApp
      • kv
        • bucket信息
        • bucket信息
        • 对象信息
        • 对象信息
      • indexer
        • syslog文档
        • 上下文信息
        • 调用者信息
      • 定时任务
        • 定时任务
        • CronJob
        • 任务
        • 任务
        • 注入参数
        • Injection
      • 索引服务
        • otel日志
        • 上下文信息
        • 调用者信息
      • 用户
        • CreateUserReq
        • BatchDisableUserReq
        • BatchDisableUserRet
        • BatchEnableUserReq
        • BatchEnableUserRet
        • BatchResetPasswordReq
        • BatchResetPasswordRet
        • ModifyUserReq
        • BatchDeleteUserReq
        • BatchDeleteUserRet
        • UserWithPage
        • UserRet
        • UserRes
        • UserDetailRet
        • UserDetailRes
        • ModifyPasswordReq
        • ModifyPasswordRet
        • ResetPasswordReq
        • UserStoredCredentialWithPage
        • UserStoredCredential
        • CreateUserStoredCredentialReq
        • CheckUserExistsReq
      • 公共响应
        • BadRequest
      • 身份源
        • AuthMethodRet
        • CreateAuthConfigRet
        • CreateAuthConfigReq
        • ModifyAuthConfigReq
        • ModifyAuthConfigRet
        • AuthConfigRet
        • AuthConfigEntity
        • DeleteAuthConfigRet
        • CreateIDPConnectionReq
        • CreateIDPConnectionRet
        • ModifyIDPConnectionReq
        • ModifyIDPConnectionRet
        • DeleteIDPConnectionRet
        • IDPConnectionRet
      • CommonRet

    使用文档

    通用字典表#

    以下是接口中全局统一使用的字典表。

    证件类型(cert_type)#

    KEYCODE值
    111身份证
    414普通护照
    513往来港澳通行证
    990其它

    性别(gender或sex)#

    KEYCODE值值Code
    male男1
    990其它0

    接口鉴权说明#

    本文档介绍如何通过AK+SK方式对接口请求进行签名和鉴权。

    签名方式#

    在请求接口时,通过X-Idmesh-Signature发送签名字符串进行鉴权。以下是签名方式的详细说明和示例代码。
    签名字符串格式:
    <nonce>$<timestamp>$v2$<ak>$<hashMethod>$<signStr>
    其中
    <nonce>:随机字符串
    <timestamp>:毫秒时间戳
    v2:指签名版本,和接口版本无关
    <ak>:用户的AK
    <hashMethod>:签名方法,目前支持sm3
    <signStr>:签名结果,采用hex编码
    签名步骤:
    1.
    设置请求参数:
    2.
    选择签名字段:
    签名字段目前只包含timestamp和nonce,并按字典序排序:
    3.
    构建待签字符串:
    将路径和待签参数按顺序拼接,并在最后添加用户的SK:
    4.
    计算签名:
    使用sm3算法对待签字符串进行摘要计算,并生成签名字符串:
    5.
    设置请求头:
    将签名字符串放入请求头的X-Idmesh-Signature字段中:
    6.
    发起请求:

    调用示例#

    以查询组织的节点列表为例

    GET /v1/tree-nodes#

    接口示例
    名称类型是否必须描述备注
    object_codeStringtrue组织编码
    nameStringfalse组织名称
    codeStringfalse组织编号
    tagStringfalse标签
    time_modified_fromStringfalse更新时间起点
    time_modified_toStringfalse更新时间终点,默认至今
    修改于 2024-10-18 06:56:29
    上一页
    IDMesh APIs
    下一页
    创建用户
    Built with