跳转至

用户管理

创建用户

功能说明

创建用户

方法原型

public void createUser(UserInfo user) throws ParamParserException, AESCryptoException, HttpRequestException;

参数说明

参数名称 类型 描述
user UserInfo 用户实体

user成员说明

user成员 必须 说明
userId 用户id(帐号),企业内必须唯一。长度为1~64个字符(包括汉字和英文字母)
name 用户名称。长度为0~64个字符(包括汉字和英文字母,可为空)
gender 性别,整型。0表示男性,1表示女性
mobile 手机号码。企业内必须唯一
phone 电话号码
email 邮箱。长度为0~64个字符
dept 所属部门列表,不超过20个

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

UserInfo user = new UserInfo();
user.setUserId("test1");
user.setGender(Const.Gender_Male);
user.setName("张三");
user.setDept(new int[]{0});
orgClient.createUser(user);
System.out.println("create user ok: test1 张三");

更新用户

功能说明

更新用户

方法原型

public void updateUser(UserInfo user) throws ParamParserException, AESCryptoException, HttpRequestException;

参数说明

参数名称 类型 描述
user UserInfo 用户实体

user成员说明

user成员 必须 说明
userId 用户id(帐号),企业内必须唯一。长度为1~64个字符(包括汉字和英文字母)
name 用户名称。长度为0~64个字符(包括汉字和英文字母,可为空)
gender 性别,整型。0表示男性,1表示女性
mobile 手机号码。企业内必须唯一
phone 电话号码
email 邮箱。长度为0~64个字符
dept 所属部门列表,不超过20个

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

UserInfo user = new UserInfo();
user.setUserId("test1");
user.setGender(Const.Gender_Male);
user.setName("李四");
user.setPhone("13112345678");
orgClient.updateUser(user);
System.out.println("update user ok: test1 李四");

删除用户

功能说明

通过userId删除用户

方法原型

public void deleteUser(String userId) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
userId String 用户名

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

orgClient.deleteUser("add");
System.out.println("delete user auth ok");

批量删除用户

功能说明

通过userId删除用户

方法原型

public void batchDeleteUser(String[] delList) throws ParamParserException, AESCryptoException, HttpRequestException;

参数说明

参数名称 类型 描述
delList String[] 用户名数组

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

String[] users = new String[]{"add", "tst1"};
orgClient.batchDeleteUser(users);
System.out.println("batch delete user auth ok");

获取用户信息

通过用户名获取用户信息

功能说明

通过用户名获取用户信息

方法原型

public UserInfo getUserInfo(String userId) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
userId String 用户名

返回结果说明

成功:返回UserInfo

失败:发生错误(如请求失败),抛出异常。

请求示例

UserInfo user = orgClient.getUserInfo("test1");
System.out.println("get userInfo ok:" + user);

通过Gid批量获取用户信息

功能说明

通过Gid批量获取用户信息

方法原型

public UserInfo[] getUserInfoListByYdGid(long[] ydGids)throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
ydGids long[] 用户Gid数组

返回结果说明

成功:返回UserInfo数组

失败:发生错误(如请求失败),抛出异常。

请求示例

long[] gidList = new long[]{100484};
UserInfo[] users = orgClient.getUserInfoListByYdGid(gidList);
if (users != null) {
    System.out.println("get userInfo ok:");
    for (UserInfo user : users) {
        System.out.println(user.toString());
    }
}

获取部门用户及信息

获取部门用户简单信息

功能说明

获取部门用户简单信息

方法原型

public UserInfo[] listDeptUserSimple(int deptId) throws AESCryptoException, ParamParserException, HttpRequestException;

参数说明

参数名称 类型 描述
deptId int 部门Id

返回结果说明

成功:返回UserInfo数组

失败:发生错误(如请求失败),抛出异常。

请求示例

UserInfo[] users = orgClient.listDeptUserSimple(26018);
for (UserInfo user : users) {
    System.out.println("get dept user simple ok:" + user);
}

获取部门用户详细信息

功能说明

获取部门用户详细信息(不包含子部门用户)

方法原型

public UserDetail[] listDeptUserDetail(int deptId) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
deptId int 部门Id

返回结果说明

成功:返回UserDetail数组

失败:发生错误(如请求失败),抛出异常。

请求示例

UserDetail[] users = orgClient.listDeptUserDetail(26018);
for (UserDetail user : users) {
    System.out.println("get dept user simple ok:" + user);
}

获取部门下所有用户详细信息

功能说明

获取部门下所有用户详细信息(包含子部门用户)

方法原型

public UserDetail[] listDeptAllUserDetail(int deptId) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
deptId int 部门Id

返回结果说明

成功:返回UserDetail数组

失败:发生错误(如请求失败),抛出异常。

请求示例

UserDetail[] users = orgClient.listDeptAllUserDetail(26018);
for (UserDetail user : users) {
    System.out.println("get dept user simple ok:" + user);
}

用户头像

通过图片地址设置用户头像

功能说明

通过图片地址设置用户头像

方法原型

public void setUserAvatar(String userId, String avatarPath) throws HttpRequestException, ParamParserException, AESCryptoException, FileIOException;

参数说明

参数名称 类型 描述
userId String 用户名
avatarPath String 文件地址

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

String userId = "test1";
String avatarFile = "D:\\pics\\avatars\\avatar1.png";
orgClient.setUserAvatar(userId, avatarFile);

通过字节码设置用户头像

功能说明

通过字节码设置用户头像

方法原型

public void setUserAvatarWithData(String userId, String avatarName,  byte[] data) throws HttpRequestException, ParamParserException, AESCryptoException, FileIOException;

参数说明

参数名称 类型 描述
userId String 用户名
avatarName String 文件名
data byte[] 文件字节码数据

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

String userId = "test1";
String avatarFile = "D:\\pics\\avatars\\avatar1.png";
byte[] data = Helper.readFile(avatarFile);
String name = Helper.readFileNameFromPath(avatarFile);
orgClient.setUserAvatarWithData(userId, name, data);

下载头像

功能说明

根据用户名下载用户头像

方法原型

public String DownloadUserAvatarAndSave(String userId, int avatarType, String dir) throws AESCryptoException, ParamParserException, HttpRequestException, FileIOException;

参数说明

参数名称 类型 描述
userId String 用户名
avatarType int 下载类型,0 大头像,1 小头像
dir String 文件存放文件夹路径

返回结果说明

成功:返回文件存放路径

失败:发生错误(如请求失败),抛出异常。

请求示例1

//下载小头像
String userId = "test1";
String avatarDir = "D:\\pics\\avatars\\";
String path = orgClient.DownloadUserAvatarAndSave(userId, Const.Avatar_Small, avatarDir);
System.out.println("download avatar small ok: " + path);

请求示例2

//下载大头像
String userId = "test1";
String avatarDir = "D:\\pics\\avatars\\";
String path = orgClient.DownloadUserAvatarAndSave(userId, Const.Avatar_Large, avatarDir);
System.out.println("download avatar large ok: " + path);