{
  "name": "eiam",
  "display_name": "数字身份管控平台（员工版）",
  "description": "数字身份管控平台（员工版）（Identity and Access Management B2E Version，以下简称 EIAM） Rest API 是为IDAM产品的合作方开发者接入并访问产品中用户管理管理、权限管理与信任规则等提供的一组工具，是访问数字身份管控平台 SaaS 服务的入口。合作伙伴可以通过数字身份管控平台 API 进行二次开发，例如新建用户，关联用户与账号，授予应用访问权限等。 |术语 |全称 |中文 |说明 | | ----...",
  "domain": "other",
  "api_version": "2021-04-20",
  "endpoint": "eiam.tencentcloudapi.com",
  "actions": [
    {
      "name": "AddAccountToAccountGroup",
      "description": "账号组添加账号",
      "status": "online",
      "parameters": [
        {
          "name": "AccountGroupId",
          "type": "string",
          "required": true,
          "description": "账号组ID",
          "example": "无"
        },
        {
          "name": "AccountIds",
          "type": "array",
          "required": false,
          "description": "加入账号组的账号ID列表。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": [
        "AccountGroupId"
      ]
    },
    {
      "name": "AddUserToUserGroup",
      "description": "加入用户到用户组",
      "status": "online",
      "parameters": [
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "加入用户组的用户ID列表。",
          "example": "id",
          "item_type": "string"
        },
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组ID，是用户组的全局唯一标识。",
          "example": "id"
        }
      ],
      "required": [
        "UserIds",
        "UserGroupId"
      ]
    },
    {
      "name": "CreateAccountGroup",
      "description": "创建账号组",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID。",
          "example": "无"
        },
        {
          "name": "GroupName",
          "type": "string",
          "required": true,
          "description": "账号组名。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述。",
          "example": "无"
        }
      ],
      "required": [
        "ApplicationId",
        "GroupName"
      ]
    },
    {
      "name": "CreateAppAccount",
      "description": "创建应用账号",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID",
          "example": "无"
        },
        {
          "name": "AccountName",
          "type": "string",
          "required": true,
          "description": "账号名称",
          "example": "无"
        },
        {
          "name": "Password",
          "type": "string",
          "required": false,
          "description": "账号密码",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述",
          "example": "无"
        }
      ],
      "required": [
        "ApplicationId",
        "AccountName"
      ]
    },
    {
      "name": "CreateOrgNode",
      "description": "新建一个机构节点",
      "status": "online",
      "parameters": [
        {
          "name": "DisplayName",
          "type": "string",
          "required": true,
          "description": "机构节点名称，长度限制：64个字符。",
          "example": "无"
        },
        {
          "name": "ParentOrgNodeId",
          "type": "string",
          "required": false,
          "description": "父机构节点ID，如果为空则默认创建在机构根节点下。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "机构节点描述。",
          "example": "无"
        },
        {
          "name": "CustomizedOrgNodeId",
          "type": "string",
          "required": false,
          "description": "机构代码。如果为空，则默认生成机构代码。如果为非空，则校验机构代码的唯一性。",
          "example": "无"
        }
      ],
      "required": [
        "DisplayName"
      ]
    },
    {
      "name": "CreateUser",
      "description": "新建一个用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "用户名，长度限制：64个字符。",
          "example": "无"
        },
        {
          "name": "Password",
          "type": "string",
          "required": true,
          "description": "用户密码， 需要符合密码策略的配置。",
          "example": "无"
        },
        {
          "name": "DisplayName",
          "type": "string",
          "required": false,
          "description": "昵称，长度限制：64个字符。 默认与用户名相同。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "用户备注，长度限制：512个字符。",
          "example": "无"
        },
        {
          "name": "UserGroupIds",
          "type": "array",
          "required": false,
          "description": "用户所属用户组ID列表。",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "Phone",
          "type": "string",
          "required": false,
          "description": "用户手机号。例如：+86-1xxxxxxxxxx。",
          "example": "无"
        },
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": false,
          "description": "用户所属的主组织机构唯一ID。如果为空，默认为在根节点下创建用户。",
          "example": "无"
        },
        {
          "name": "ExpirationTime",
          "type": "string",
          "required": false,
          "description": "用户过期时间，遵循 ISO 8601 标准。",
          "example": "无"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "用户邮箱。",
          "example": "无"
        },
        {
          "name": "PwdNeedReset",
          "type": "boolean",
          "required": false,
          "description": "密码是否需要重置，为空默认为false不需要重置密码。",
          "example": "无"
        },
        {
          "name": "SecondaryOrgNodeIdList",
          "type": "array",
          "required": false,
          "description": "用户所属的次要组织机构ID列表。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": [
        "UserName",
        "Password"
      ]
    },
    {
      "name": "CreateUserGroup",
      "description": "新建用户组",
      "status": "online",
      "parameters": [
        {
          "name": "DisplayName",
          "type": "string",
          "required": true,
          "description": "用户组昵称，长度限制：64个字符。 DisplayName是唯一的。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "用户组备注，长度限制：512个字符。",
          "example": "无"
        }
      ],
      "required": [
        "DisplayName"
      ]
    },
    {
      "name": "DeleteAccountGroup",
      "description": "删除账号组",
      "status": "online",
      "parameters": [
        {
          "name": "AccountGroupIdList",
          "type": "array",
          "required": true,
          "description": "账号组ID数组。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": [
        "AccountGroupIdList"
      ]
    },
    {
      "name": "DeleteAppAccount",
      "description": "删除应用账号",
      "status": "online",
      "parameters": [
        {
          "name": "AccountIdList",
          "type": "array",
          "required": true,
          "description": "账号ID数组。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": [
        "AccountIdList"
      ]
    },
    {
      "name": "DeleteOrgNode",
      "description": "删除一个机构节点",
      "status": "online",
      "parameters": [
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": true,
          "description": "机构节点ID，是机构节点的全局唯一标识。",
          "example": "无"
        }
      ],
      "required": [
        "OrgNodeId"
      ]
    },
    {
      "name": "DeleteUser",
      "description": "通过用户名或用户 id 删除用户。",
      "status": "online",
      "parameters": [
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名，长度限制：32个字符。 Username 和 UserId 需选择一个作为搜索条件；如两个条件同时使用则默认使用Username作为搜索条件。",
          "example": "无"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "用户 id。 Username 和 UserId 需选择一个作为搜索条件；如两个条件同时使用则默认使用Username作为搜索条件。",
          "example": "id"
        }
      ],
      "required": []
    },
    {
      "name": "DeleteUserGroup",
      "description": "删除一个用户组",
      "status": "online",
      "parameters": [
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组ID，是用户组的全局唯一标识。",
          "example": "id"
        }
      ],
      "required": [
        "UserGroupId"
      ]
    },
    {
      "name": "DeleteUsers",
      "description": "批量删除当前节点下的用户。如果出现个别用户删除错误，将不影响其余被勾选用户被删除的操作，同时提示未被删除的用户名称/用户ID。",
      "status": "online",
      "parameters": [
        {
          "name": "DeleteIdList",
          "type": "array",
          "required": false,
          "description": "被删除用户的ID列表。DeleteIdList 和 DeleteNameList 需至少一个不为空；都不为空时优先使用 DeleteNameList。",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "DeleteNameList",
          "type": "array",
          "required": false,
          "description": "被删除用户的名称列表。DeleteIdList 和 DeleteNameList 需至少一个不为空；都不为空时优先使用 DeleteNameList。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAccountGroup",
      "description": "查询账号组列表",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID。",
          "example": "无"
        },
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "查询条件，支持多搜索条件组合、多数据范围匹配的搜索。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（*）结尾表示字段部分匹配。如果该字段为空，则默认查全量表。",
          "example": "无",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "关键字",
              "example": "比赛一组"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为 0。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为 20，最大值为 100。",
          "example": "无"
        }
      ],
      "required": [
        "ApplicationId"
      ]
    },
    {
      "name": "DescribeAppAccount",
      "description": "查询应用账号列表",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID。",
          "example": "无"
        },
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "查询条件，支持多搜索条件组合、多数据范围匹配的搜索。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（*）结尾表示字段部分匹配。如果该字段为空，则默认查全量表。",
          "example": "无",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "关键字",
              "example": "张三"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为 0。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为 20，最大值为 100。",
          "example": "无"
        }
      ],
      "required": [
        "ApplicationId"
      ]
    },
    {
      "name": "DescribeApplication",
      "description": "获取一个应用的信息。",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": false,
          "description": "应用id，是应用的全局唯一标识，与ClientId参数不能同时为空。",
          "example": "无"
        },
        {
          "name": "ClientId",
          "type": "string",
          "required": false,
          "description": "客户端id，与ApplicationId参数不能同时为空。",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeOrgNode",
      "description": "根据机构节点ID读取机构节点信息",
      "status": "online",
      "parameters": [
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": false,
          "description": "机构节点ID，是机构节点全局唯一标识，长度限制：64个字符。如果为空默认读取机构根节点信息。",
          "example": "无"
        },
        {
          "name": "IncludeOrgNodeChildInfo",
          "type": "boolean",
          "required": false,
          "description": "是否读取其子节点信息。当其为空或false时，默认仅读取当前机构节点信息。当其为true时，读取本机构节点以及其第一层子节点信息。",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeOrgResourcesAuthorization",
      "description": "查询指定机构下的资源授权列表",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID",
          "example": "无"
        },
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": true,
          "description": "机构ID",
          "example": "无"
        }
      ],
      "required": [
        "ApplicationId",
        "OrgNodeId"
      ]
    },
    {
      "name": "DescribePublicKey",
      "description": "获取JWT公钥信息。",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID，是应用的全局唯一标识。",
          "example": "id"
        }
      ],
      "required": [
        "ApplicationId"
      ]
    },
    {
      "name": "DescribeUserGroup",
      "description": "获取用户组信息",
      "status": "online",
      "parameters": [
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组ID，是用户组的全局唯一标识。",
          "example": "id"
        }
      ],
      "required": [
        "UserGroupId"
      ]
    },
    {
      "name": "DescribeUserGroupResourcesAuthorization",
      "description": "查询指定用户组下的资源授权列表",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID",
          "example": "无"
        },
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组ID",
          "example": "无"
        }
      ],
      "required": [
        "ApplicationId",
        "UserGroupId"
      ]
    },
    {
      "name": "DescribeUserInfo",
      "description": "通过用户名或用户 id 搜索用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名，长度限制：64个字符。 Username 和 UserId 需至少一个不为空；都不为空时优先使用 Username。",
          "example": "无"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "用户 id，长度限制：64个字符。 Username 和 UserId 需至少一个不为空；都不为空时优先使用 Username。",
          "example": "id"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeUserResourcesAuthorization",
      "description": "查询指定用户下的资源授权列表",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID。",
          "example": "无"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "用户ID。UserName 和 UserId 需至少一个不为空；都不为空时优先使用 UserName。",
          "example": "无"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名。UserName 和 UserId 需至少一个不为空；都不为空时优先使用 UserName。",
          "example": "zhangsan"
        },
        {
          "name": "IncludeInheritedAuthorizations",
          "type": "boolean",
          "required": false,
          "description": "查询范围是否包括用户关联的用户组、组织机构的应用访问权限。默认为不查询 ，传false表示不查询该范围，传true查询该范围。",
          "example": "true"
        }
      ],
      "required": [
        "ApplicationId"
      ]
    },
    {
      "name": "DescribeUserThirdPartyAccountInfo",
      "description": "通过用户名或用户 id 获取用户的第三方账号绑定信息。",
      "status": "online",
      "parameters": [
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名。 Username 和 UserId 需至少一个不为空；都不为空时优先使用 Username。",
          "example": "无"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "用户 ID。 Username 和 UserId 需至少一个不为空；都不为空时优先使用 Username。",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "ListAccountInAccountGroup",
      "description": "获取账号组中的账号列表",
      "status": "online",
      "parameters": [
        {
          "name": "AccountGroupId",
          "type": "string",
          "required": true,
          "description": "账号组ID。",
          "example": "无"
        },
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "查询条件，支持多搜索条件组合、多数据范围匹配的搜索。",
          "example": "无",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "关键字",
              "example": "比赛一组"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为 0。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为 20，最大值为 100。",
          "example": "无"
        }
      ],
      "required": [
        "AccountGroupId"
      ]
    },
    {
      "name": "ListApplicationAuthorizations",
      "description": "应用授权关系列表（含搜索条件匹配）。",
      "status": "online",
      "parameters": [
        {
          "name": "EntityType",
          "type": "string",
          "required": true,
          "description": "查询类型，包含用户（User）、用户组（UserGroup）、组织机构（OrgNode）。",
          "example": "无"
        },
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "查询条件，支持多搜索条件组合、多数据范围匹配的搜索。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（\"\"）表示全匹配、以星号（* ) 结尾表示字段部分匹配。如果该字段为空，则默认查全量表。",
          "example": "无",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "名称匹配搜索，当查询类型为用户时，匹配范围包括：用户名称、应用名称；当查询类型为用户组时，匹配范围包括：用户组名称、应用名称；当查询类型为组织机构时，匹配范围包括：组织机构名称、应用名称。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：上次修改时间（lastModifiedDate）。如果该字段为空，则默认按照应用名称正向排序。",
          "example": "无",
          "children": [
            {
              "name": "SortKey",
              "type": "string",
              "required": true,
              "description": "排序属性。",
              "example": "无"
            },
            {
              "name": "SortOrder",
              "type": "string",
              "required": true,
              "description": "排序顺序，ASC为正向排序，DESC为反向排序。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页读取数量。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询。",
          "example": "无"
        }
      ],
      "required": [
        "EntityType"
      ]
    },
    {
      "name": "ListApplications",
      "description": "获取应用列表信息。",
      "status": "online",
      "parameters": [
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "模糊匹配搜索条件，支持多搜索条件组合、多数据范围匹配的搜索。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（\"\"）表示全匹配、以星号（* ) 结尾表示字段部分匹配。模糊匹配搜索功能与精准匹配查询不会同时生效，如果SearchCondition与ApplicationIdList均不为空，则默认以ApplicationIdList进行精准查询。如果SearchCondition字段与Applica...",
          "example": "无",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "应用匹配搜索关键字，匹配范围包括：应用名称、应用ID。",
              "example": "无"
            },
            {
              "name": "ApplicationType",
              "type": "string",
              "required": false,
              "description": "应用类型。ApplicationType的取值范围有：OAUTH2、JWT、CAS、SAML2、FORM、OIDC、APIGW。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：应用名字（DisplayName）、创建时间（CreatedDate）、上次修改时间（LastModifiedDate）。如果该字段为空，则默认按照应用名字正向排序。",
          "example": "无",
          "children": [
            {
              "name": "SortKey",
              "type": "string",
              "required": true,
              "description": "排序属性。",
              "example": "无"
            },
            {
              "name": "SortOrder",
              "type": "string",
              "required": true,
              "description": "排序顺序，ASC为正向排序，DESC为反向排序。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：应用名字（DisplayName）、创建时间（CreatedDate）、上次修改时间（LastModifiedDate）。如果该字段为空，则默认按照应用名字正向排序。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页读取数量。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询。",
          "example": "无"
        },
        {
          "name": "ApplicationIdList",
          "type": "array",
          "required": false,
          "description": "应用ID列表，通过应用ID列表精准匹配对应的应用信息。模糊匹配搜索功能与精准匹配查询不会同时生效，如果SearchCondition与ApplicationIdList均不为空，则默认以ApplicationIdList进行精准查询。如果SearchCondition字段与ApplicationIdList字段均为空，则默认返回全部的应用信息。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "ListAuthorizedApplicationsToOrgNode",
      "description": "通过机构节点ID获得被授权访问的应用列表。",
      "status": "online",
      "parameters": [
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": true,
          "description": "机构节点 Id 。",
          "example": "id"
        }
      ],
      "required": [
        "OrgNodeId"
      ]
    },
    {
      "name": "ListAuthorizedApplicationsToUser",
      "description": "通过用户ID获得被授权访问的应用列表。",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户 ID。",
          "example": "id"
        },
        {
          "name": "IncludeInheritedAuthorizations",
          "type": "boolean",
          "required": false,
          "description": "查询范围是否包括用户关联的用户组、组织机构的应用访问权限。默认为不查询 。传false表示不查询该范围，传true表示应用查询该范围。",
          "example": "无"
        }
      ],
      "required": [
        "UserId"
      ]
    },
    {
      "name": "ListAuthorizedApplicationsToUserGroup",
      "description": "通过用户组ID获得被授权访问的应用列表。",
      "status": "online",
      "parameters": [
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组 Id 。",
          "example": "id"
        }
      ],
      "required": [
        "UserGroupId"
      ]
    },
    {
      "name": "ListUserGroups",
      "description": "获取用户组列表信息（包含查询条件）。",
      "status": "online",
      "parameters": [
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "查询条件，支持多搜索条件组合、多数据范围匹配的搜索。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（\"\"）表示全匹配、以星号（* ) 结尾表示字段部分匹配。如果该字段为空，则默认查全量表。",
          "example": "无",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "名称匹配搜索，匹配范围包括：用户组名称、用户组ID。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：用户组名称（DisplayName）、用户组ID（UserGroupId）、上次更新时间（LastModifiedDate）。如果该字段为空，则默认按照用户组名称正向排序。",
          "example": "无",
          "children": [
            {
              "name": "SortKey",
              "type": "string",
              "required": true,
              "description": "排序属性。",
              "example": "无"
            },
            {
              "name": "SortOrder",
              "type": "string",
              "required": true,
              "description": "排序顺序，ASC为正向排序，DESC为反向排序。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页读取数量。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询。",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "ListUserGroupsOfUser",
      "description": "获取用户所在的用户组列表",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID，是用户的全局唯一标识。",
          "example": "id"
        },
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "模糊查询条件，支持匹配用户组名称（DisplayName）。如果该字段为空，则默认展示该用户所有的用户组。",
          "example": "无",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "名称匹配搜索，匹配范围包括：用户组名称。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：用户组名称（DisplayName）、用户组ID（UserGroupId）、创建时间（CreatedDate）。如果该字段为空，则默认按照用户组名称正向排序。",
          "example": "无",
          "children": [
            {
              "name": "SortKey",
              "type": "string",
              "required": true,
              "description": "排序属性。",
              "example": "无"
            },
            {
              "name": "SortOrder",
              "type": "string",
              "required": true,
              "description": "排序顺序，ASC为正向排序，DESC为反向排序。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量，默认为0。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户组。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页读取数量，默认为50，最大值为100。 Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户组。",
          "example": "无"
        }
      ],
      "required": [
        "UserId"
      ]
    },
    {
      "name": "ListUsers",
      "description": "获取用户列表信息。",
      "status": "online",
      "parameters": [
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "用户属性搜索条件，可查询条件包括：用户名、手机号码，邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间，支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（*）结尾表示字段部分匹配、中括号以逗号分隔（[Min，Max]）表示闭区间查询、大括号以逗号\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "UserName",
              "type": "string",
              "required": false,
              "description": "用户名，长度限制：64个字符。",
              "example": "无"
            },
            {
              "name": "Phone",
              "type": "string",
              "required": false,
              "description": "用户手机号。",
              "example": "无"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "无"
            },
            {
              "name": "Status",
              "type": "string",
              "required": false,
              "description": "用户状态，取值 NORMAL （正常）、FREEZE （已冻结）、LOCKED （已锁定）或 NOT_ENABLED （未启用）。",
              "example": "无"
            },
            {
              "name": "CreationTime",
              "type": "string",
              "required": false,
              "description": "用户创建时间，遵循 ISO 8601 标准。",
              "example": "无"
            },
            {
              "name": "LastUpdateTime",
              "type": "string",
              "required": false,
              "description": "用户上次更新时间区间。",
              "example": "无"
            },
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "名称匹配搜索，匹配范围包括：用户名称、用户ID。",
              "example": "无"
            }
          ]
        },
        {
          "name": "ExpectedFields",
          "type": "array",
          "required": false,
          "description": "指定期望返回的用户属性，默认返回所有用户内置属性。内置用户属性包括：用户UUID（UserId）、用户昵称（DisplayName）、用户名字（UserName）、手机号（Phone）、邮箱（Email）、用户状态（Status）、用户组（SubjectGroups）机构路径（OrgPath）、备注（Description）、创建时间 （CreationTime）、上次修改时间（LastUpdateTime）、上次登录时间（LastLoginTime）。",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：用户名字（UserName）、用户昵称（DisplayName）、手机号（Phone）、邮箱（Email）、用户状态（Status）、创建时间 （CreationTime）、上次修改时间（LastUpdateTime）、上次登录时间（LastLoginTime）。如果不指定，则默认按照用户昵称（DisplayName）正向排序。",
          "example": "无",
          "children": [
            {
              "name": "SortKey",
              "type": "string",
              "required": true,
              "description": "排序属性。",
              "example": "无"
            },
            {
              "name": "SortOrder",
              "type": "string",
              "required": true,
              "description": "排序顺序，ASC为正向排序，DESC为反向排序。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量，默认为0。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多1000个用户。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页读取数量，默认为50，最大值为100。 Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多1000个用户。",
          "example": "无"
        },
        {
          "name": "IncludeTotal",
          "type": "boolean",
          "required": false,
          "description": "是否查看搜索结果的总数，默认该选项为false不查看。",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "ListUsersInOrgNode",
      "description": "根据机构节点ID读取节点下用户",
      "status": "online",
      "parameters": [
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": false,
          "description": "机构节点ID，是机构节点全局唯一标识，长度限制：64个字符。如果为空默认读取机构根节点下用户信息。",
          "example": "id"
        },
        {
          "name": "IncludeOrgNodeChildInfo",
          "type": "boolean",
          "required": false,
          "description": "是否读取其子节点信息。当其为空或false时，默认仅读取当前机构节点信息。当其为true时，读取本机构节点以及其第一层子节点信息。",
          "example": "无"
        },
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "用户属性搜索条件，可查询条件包括：用户名、手机号码，邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间，支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（*）结尾表示字段部分匹配、中括号以逗号分隔（[Min，Max]）表示闭区间查询、大括号以逗号\ufffd\ufffd...",
          "example": "无",
          "children": [
            {
              "name": "UserName",
              "type": "string",
              "required": false,
              "description": "用户名，长度限制：64个字符。",
              "example": "无"
            },
            {
              "name": "Phone",
              "type": "string",
              "required": false,
              "description": "用户手机号。",
              "example": "无"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "无"
            },
            {
              "name": "Status",
              "type": "string",
              "required": false,
              "description": "用户状态，取值 NORMAL （正常）、FREEZE （已冻结）、LOCKED （已锁定）或 NOT_ENABLED （未启用）。",
              "example": "无"
            },
            {
              "name": "CreationTime",
              "type": "string",
              "required": false,
              "description": "用户创建时间，遵循 ISO 8601 标准。",
              "example": "无"
            },
            {
              "name": "LastUpdateTime",
              "type": "string",
              "required": false,
              "description": "用户上次更新时间。",
              "example": "无"
            },
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "名称匹配搜索，匹配范围包括：用户名称、用户手机号。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：用户名字（UserName）、手机号（Phone）、邮箱（Email）、用户状态（Status）、创建时间 （CreatedDate）、上次更新时间（LastModifiedDate）。如果不指定，则默认按照用户昵称（DisplayName）正向排序。",
          "example": "无",
          "children": [
            {
              "name": "SortKey",
              "type": "string",
              "required": true,
              "description": "排序属性。",
              "example": "无"
            },
            {
              "name": "SortOrder",
              "type": "string",
              "required": true,
              "description": "排序顺序，ASC为正向排序，DESC为反向排序。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量，默认为0。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页读取数量，默认为50，最大值为100。 Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户。",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "ListUsersInUserGroup",
      "description": "获取用户组中的用户列表",
      "status": "online",
      "parameters": [
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组ID，是用户组的全局唯一标识。",
          "example": "id"
        },
        {
          "name": "SearchCondition",
          "type": "object",
          "required": false,
          "description": "用户属性搜索条件，可查询条件包括：用户名、手机号码，邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间，支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（）结尾表示字段部分匹配、中括号以逗号分隔（[Min，Max]）表示闭区间查询、大括号以逗号分...",
          "example": "无",
          "children": [
            {
              "name": "UserName",
              "type": "string",
              "required": false,
              "description": "用户名，长度限制：64个字符。",
              "example": "无"
            },
            {
              "name": "Phone",
              "type": "string",
              "required": false,
              "description": "用户手机号。",
              "example": "无"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "用户邮箱。",
              "example": "无"
            },
            {
              "name": "Status",
              "type": "string",
              "required": false,
              "description": "用户状态，取值 NORMAL （正常）、FREEZE （已冻结）、LOCKED （已锁定）或 NOT_ENABLED （未启用）。",
              "example": "无"
            },
            {
              "name": "CreationTime",
              "type": "string",
              "required": false,
              "description": "用户创建时间，遵循 ISO 8601 标准。",
              "example": "无"
            },
            {
              "name": "LastUpdateTime",
              "type": "string",
              "required": false,
              "description": "用户上次更新时间区间。",
              "example": "无"
            },
            {
              "name": "Keyword",
              "type": "string",
              "required": false,
              "description": "名称匹配搜索，匹配范围包括：用户名称、用户ID。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序条件集合。可排序的属性支持：用户名字（UserName）、用户昵称（DisplayName）、手机号（Phone）、邮箱（Email）、用户状态（Status）、创建时间 （CreatedDate）、上次更新时间（LastModifiedDate）。如果不指定，则默认按照用户昵称（DisplayName）正向排序。",
          "example": "无",
          "children": [
            {
              "name": "SortKey",
              "type": "string",
              "required": true,
              "description": "排序属性。",
              "example": "无"
            },
            {
              "name": "SortOrder",
              "type": "string",
              "required": true,
              "description": "排序顺序，ASC为正向排序，DESC为反向排序。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量，默认为0。Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页读取数量，默认为50，最大值为100。 Offset 和 Limit 两个字段需配合使用，即其中一个指定了，另一个必须指定。 如果不指定以上参数，则表示不进行分页查询，即只返回最多50个用户。",
          "example": "无"
        }
      ],
      "required": [
        "UserGroupId"
      ]
    },
    {
      "name": "ModifyAccountGroup",
      "description": "修改账号组",
      "status": "online",
      "parameters": [
        {
          "name": "AccountGroupId",
          "type": "string",
          "required": true,
          "description": "账号组ID。",
          "example": "无"
        },
        {
          "name": "GroupName",
          "type": "string",
          "required": false,
          "description": "账号组名。未传入该参数时，表示不进行修改。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述，未传入该参数时，表示不进行修改。",
          "example": "无"
        }
      ],
      "required": [
        "AccountGroupId"
      ]
    },
    {
      "name": "ModifyAppAccount",
      "description": "修改应用账号",
      "status": "online",
      "parameters": [
        {
          "name": "AccountId",
          "type": "string",
          "required": true,
          "description": "账号ID。",
          "example": "无"
        },
        {
          "name": "AccountName",
          "type": "string",
          "required": false,
          "description": "账号名称。未传入该参数时，表示不进行修改。",
          "example": "无"
        },
        {
          "name": "Password",
          "type": "string",
          "required": false,
          "description": "账号密码。未传入该参数时，表示不进行修改。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述，未传入该参数时，表示不进行修改。",
          "example": "无"
        }
      ],
      "required": [
        "AccountId"
      ]
    },
    {
      "name": "ModifyApplication",
      "description": "更新一个应用的信息",
      "status": "online",
      "parameters": [
        {
          "name": "ApplicationId",
          "type": "string",
          "required": true,
          "description": "应用ID，是应用的全局唯一标识。",
          "example": "id"
        },
        {
          "name": "SecureLevel",
          "type": "string",
          "required": false,
          "description": "安全级别。",
          "example": "无"
        },
        {
          "name": "DisplayName",
          "type": "string",
          "required": false,
          "description": "应用展示名称，长度限制：32个字符。 默认与应用名字相同。",
          "example": "无"
        },
        {
          "name": "AppStatus",
          "type": "boolean",
          "required": false,
          "description": "应用状态，true表示启用，false表示禁用。",
          "example": "无"
        },
        {
          "name": "IconUrl",
          "type": "string",
          "required": false,
          "description": "应用图标图片访问地址。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述。长度不超过128。",
          "example": "无"
        }
      ],
      "required": [
        "ApplicationId"
      ]
    },
    {
      "name": "ModifyUserInfo",
      "description": "通过用户名或用户 id 冻结用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名，长度限制：32个字符。 Username 和 UserId 需选择一个作为搜索条件；如两个条件同时使用则默认使用Username作为搜索条件。",
          "example": "无"
        },
        {
          "name": "DisplayName",
          "type": "string",
          "required": false,
          "description": "昵称，长度限制：64个字符。 默认与用户名相同。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "用户备注，长度限制：512个字符。",
          "example": "无"
        },
        {
          "name": "UserGroupIds",
          "type": "array",
          "required": false,
          "description": "用户所属用户组ID列表。",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "用户 id。 Username 和 UserId 需选择一个作为搜索条件；如两个条件同时使用则默认使用Username作为搜索条件。",
          "example": "id"
        },
        {
          "name": "Phone",
          "type": "string",
          "required": false,
          "description": "用户手机号。",
          "example": "无"
        },
        {
          "name": "ExpirationTime",
          "type": "string",
          "required": false,
          "description": "用户过期时间，遵循 ISO 8601 标准。",
          "example": "无"
        },
        {
          "name": "Password",
          "type": "string",
          "required": false,
          "description": "用户密码， 需要符合密码策略的配置。",
          "example": "无"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "用户邮箱。",
          "example": "无"
        },
        {
          "name": "PwdNeedReset",
          "type": "boolean",
          "required": false,
          "description": "密码是否需要重置，为空默认为false不需要重置密码。",
          "example": "无"
        },
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": false,
          "description": "用户所属的主组织机构唯一ID。如果为空，默认为在根节点下创建用户。",
          "example": "无"
        },
        {
          "name": "SecondaryOrgNodeIdList",
          "type": "array",
          "required": false,
          "description": "用户所属的次要组织机构ID列表。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "RemoveAccountFromAccountGroup",
      "description": "从账号组中移除账号",
      "status": "online",
      "parameters": [
        {
          "name": "AccountGroupId",
          "type": "string",
          "required": true,
          "description": "账号组ID",
          "example": "无"
        },
        {
          "name": "AccountIds",
          "type": "array",
          "required": false,
          "description": "需要移除账号ID列表。",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": [
        "AccountGroupId"
      ]
    },
    {
      "name": "RemoveUserFromUserGroup",
      "description": "从用户组中移除用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserIds",
          "type": "array",
          "required": true,
          "description": "要加入用户组的用户ID列表。",
          "example": "id",
          "item_type": "string"
        },
        {
          "name": "UserGroupId",
          "type": "string",
          "required": true,
          "description": "用户组ID，是用户组的全局唯一标识。",
          "example": "id"
        }
      ],
      "required": [
        "UserIds",
        "UserGroupId"
      ]
    },
    {
      "name": "UpdateOrgNode",
      "description": "新建一个机构节点，",
      "status": "online",
      "parameters": [
        {
          "name": "OrgNodeId",
          "type": "string",
          "required": true,
          "description": "机构节点ID，是机构节点的全局唯一标识。",
          "example": "id"
        },
        {
          "name": "DisplayName",
          "type": "string",
          "required": true,
          "description": "机构节点名称，长度限制：64个字符。",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "机构节点描述。",
          "example": "无"
        },
        {
          "name": "CustomizedOrgNodeId",
          "type": "string",
          "required": false,
          "description": "机构代码。如果非空则校验此ID的唯一性。",
          "example": "id"
        }
      ],
      "required": [
        "OrgNodeId",
        "DisplayName"
      ]
    }
  ]
}