https://cic_irc.yuque.com/tyl581/ggwv9w/xhap0wi0mdbab9sa
一、pom坐标
<dependency>
<groupId>com.aliyun.fsi.insurance</groupId>
<artifactId>aboss-sso-client</artifactId>
<version>1.3.5-RELEASE</version>
</dependency>
二、接口列表
1. 账号查询相关
1.1. 根据账户id查询用户详细信息
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountInfo(com.aliyun.fsi.insurance.sso.dto.AccountIdQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accId | string | 账户id | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-info --data '{
"accId": "96"
}'
Response-fields:
| Field | Type | Description | Since |
| accId | string | 账户Id | - |
| accountName | string | 登录名称 | - |
| externalId | string | 外部id | - |
| displayName | string | 显示名称 | - |
| accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| accountStartDt | string | 账户有效期-起期 | - |
| accountEndDt | string | 账户有效期-止期 | - |
| faceId | string | 人脸识别图片fileid | - |
| avatarId | string | 账户图片fileid | - |
| branchOrgCode | string | 归属组织编码 | - |
| branchOrgName | string | 归属组织名称 | - |
| operatingOrgCode | string | 所属经营组织编码 | - |
| operatingOrgName | string | 所属经营组织名称 | - |
| externalSource | string | 外部id所属来源(应用名) | - |
| externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| enabled | boolean | 账户状态(true:启用，false:禁用) | - |
| isValid | boolean | 在职状态（true：在职，false：离职） | - |
| twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| dingUserId | string | 钉钉userId | - |
| beforePhoneNo | string | 之前使用的手机号 | - |
| beforeEmail | string | 之前使用的邮箱 | - |
| gmtModified | string | 修改时间 | - |
Response-example:
{
"accId": "96",
"accountName": "andy.rath",
"externalId": "96",
"displayName": "andy.rath",
"accountRole": "2znc0k",
"accountType": "83ioez",
"phoneNo": "obwtq4",
"email": "thurman.satterfield@gmail.com",
"accountStartDt": "7hivso",
"accountEndDt": "un2djf",
"faceId": "96",
"avatarId": "96",
"branchOrgCode": "68766",
"branchOrgName": "andy.rath",
"operatingOrgCode": "68766",
"operatingOrgName": "andy.rath",
"externalSource": "9omcfx",
"externalHead": "gq5cld",
"enabled": true,
"isValid": true,
"twoFactor": true,
"dingUserId": "96",
"beforePhoneNo": "pidyoi",
"beforeEmail": "thurman.satterfield@gmail.com",
"gmtModified": "2024-02-29 16:47:06"
}
1.2. 根据账户id集合查找用户详细信息列表
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountListByAccountIds(com.aliyun.fsi.insurance.sso.dto.AccountListByAccountIdsQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accIds | array | 账户id集合（最多100条） | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-list-by-accountIds --data '{
"accIds": [
"dae7la"
]
}'
Response-fields:
| Field | Type | Description | Since |
| accId | string | 账户Id | - |
| accountName | string | 登录名称 | - |
| externalId | string | 外部id | - |
| displayName | string | 显示名称 | - |
| accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| accountStartDt | string | 账户有效期-起期 | - |
| accountEndDt | string | 账户有效期-止期 | - |
| faceId | string | 人脸识别图片fileid | - |
| avatarId | string | 账户图片fileid | - |
| branchOrgCode | string | 归属组织编码 | - |
| branchOrgName | string | 归属组织名称 | - |
| operatingOrgCode | string | 所属经营组织编码 | - |
| operatingOrgName | string | 所属经营组织编码 | - |
| externalSource | string | 外部id所属来源(应用名) | - |
| externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| enabled | boolean | 账户状态(true:启用，false:禁用) | - |
| isValid | boolean | 是否有效 | - |
| twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| dingUserId | string | 钉钉userId | - |
| beforePhoneNo | string | 之前使用的手机号 | - |
| beforeEmail | string | 之前使用的邮箱 | - |
| gmtModified | string | 修改时间 | - |
Response-example:
[
{
"accId": "96",
"accountName": "andy.rath",
"externalId": "96",
"displayName": "andy.rath",
"accountRole": "sxdzt6",
"accountType": "s8yjtp",
"phoneNo": "06uqzm",
"email": "thurman.satterfield@gmail.com",
"accountStartDt": "zvfvsu",
"accountEndDt": "gbkp0j",
"faceId": "96",
"avatarId": "96",
"branchOrgCode": "68766",
"branchOrgName": "andy.rath",
"operatingOrgCode": "68766",
"operatingOrgName": "andy.rath",
"externalSource": "81xx8q",
"externalHead": "2ig6wh",
"enabled": true,
"isValid": true,
"twoFactor": true,
"dingUserId": "96",
"beforePhoneNo": "3oay9d",
"beforeEmail": "thurman.satterfield@gmail.com",
"gmtModified": "2024-02-29 16:47:06"
}
]
1.3. 根据归属组织编码查找用户详细信息集合(不包含下级机构)
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountListByBranchOrgCode(com.aliyun.fsi.insurance.sso.dto.BranchOrgCodeQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| branchOrgCode | string | 归属组织编码 | true | - |
| isValid | boolean | 在职状态(true:在职，false:离职，不传返回所有) | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-list-by-branch-org-code --data '{
"branchOrgCode": "68766",
"isValid": true
}'
Response-fields:
| Field | Type | Description | Since |
| data | array | No comments found. | - |
| └─accId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| └─externalId | string | 外部id | - |
| └─displayName | string | 显示名称 | - |
| └─accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| └─accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| └─phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| └─accountStartDt | string | 账户有效期-起期 | - |
| └─accountEndDt | string | 账户有效期-止期 | - |
| └─faceId | string | 人脸识别图片fileid | - |
| └─avatarId | string | 账户图片fileid | - |
| └─branchOrgCode | string | 归属组织编码 | - |
| └─branchOrgName | string | 归属组织名称 | - |
| └─operatingOrgCode | string | 所属经营组织编码 | - |
| └─operatingOrgName | string | 所属经营组织编码 | - |
| └─externalSource | string | 外部id所属来源(应用名) | - |
| └─externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| └─enabled | boolean | 账户状态(true:启用，false:禁用) | - |
| └─isValid | boolean | 是否有效 | - |
| └─twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| └─dingUserId | string | 钉钉userId | - |
| └─beforePhoneNo | string | 之前使用的手机号 | - |
| └─beforeEmail | string | 之前使用的邮箱 | - |
| └─gmtModified | string | 修改时间 | - |
| pageSize | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
Response-example:
{
"data": [
{
"accId": "96",
"accountName": "andy.rath",
"externalId": "96",
"displayName": "andy.rath",
"accountRole": "y6tmdr",
"accountType": "qzlsac",
"phoneNo": "k82j6o",
"email": "thurman.satterfield@gmail.com",
"accountStartDt": "j7uu8w",
"accountEndDt": "oq71y5",
"faceId": "96",
"avatarId": "96",
"branchOrgCode": "68766",
"branchOrgName": "andy.rath",
"operatingOrgCode": "68766",
"operatingOrgName": "andy.rath",
"externalSource": "ua1asz",
"externalHead": "zfm5z9",
"enabled": true,
"isValid": true,
"twoFactor": true,
"dingUserId": "96",
"beforePhoneNo": "beascp",
"beforeEmail": "thurman.satterfield@gmail.com",
"gmtModified": "2024-02-29 16:47:06"
}
],
"pageSize": 10,
"totalCount": 283,
"pageIndex": 1,
"message": {},
"status": 994
}
1.4. 根据关键字模糊查询(分页)
Description: com.aliyun.fsi.insurance.sso.impl.AccountRpcFacadeImpl#accountListByKeyword(com.aliyun.fsi.insurance.sso.dto.KeywordQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| pageSize | int32 | 每页展示条数(最大100条) | true | - |
| pageIndex | int32 | 当前页码 | true | - |
| keyword | string | 模糊查询关键字 账号名 用户名 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-list-by-keyword --data '{
"pageSize": 10,
"pageIndex": 1,
"keyword": "vtr6qw"
}'
Response-fields:
| Field | Type | Description | Since |
| data | array | No comments found. | - |
| └─accId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| └─externalId | string | 外部id | - |
| └─displayName | string | 显示名称 | - |
| └─accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| └─accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| └─phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| └─accountStartDt | string | 账户有效期-起期 | - |
| └─accountEndDt | string | 账户有效期-止期 | - |
| └─faceId | string | 人脸识别图片fileid | - |
| └─avatarId | string | 账户图片fileid | - |
| └─branchOrgCode | string | 归属组织编码 | - |
| └─branchOrgName | string | 归属组织名称 | - |
| └─operatingOrgCode | string | 所属经营组织编码 | - |
| └─operatingOrgName | string | 所属经营组织编码 | - |
| └─externalSource | string | 外部id所属来源(应用名) | - |
| └─externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| └─enabled | boolean | 账户状态(true:启用，false:禁用) | - |
| └─isValid | boolean | 是否有效 | - |
| └─twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| └─dingUserId | string | 钉钉userId | - |
| └─beforePhoneNo | string | 之前使用的手机号 | - |
| └─beforeEmail | string | 之前使用的邮箱 | - |
| └─gmtModified | string | 修改时间 | - |
| pageSize | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
| needRetry | boolean | No comments found. | - |
| extendInfo | map | No comments found. | - |
| └─any object | object | any object. | - |
Response-example:
{
"data": [
{
"accId": "96",
"accountName": "andy.rath",
"externalId": "96",
"displayName": "andy.rath",
"accountRole": "z4z851",
"accountType": "j1cfzu",
"phoneNo": "xba6ux",
"email": "thurman.satterfield@gmail.com",
"accountStartDt": "ckzwmv",
"accountEndDt": "05ls8c",
"faceId": "96",
"avatarId": "96",
"branchOrgCode": "68766",
"branchOrgName": "andy.rath",
"operatingOrgCode": "68766",
"operatingOrgName": "andy.rath",
"externalSource": "n8h7yv",
"externalHead": "kgvzkl",
"enabled": true,
"isValid": true,
"twoFactor": true,
"dingUserId": "96",
"beforePhoneNo": "57fzsr",
"beforeEmail": "thurman.satterfield@gmail.com",
"gmtModified": "2024-02-29 16:47:06"
}
],
"pageSize": 10,
"totalCount": 475,
"pageIndex": 1,
"message": {},
"status": 792,
"needRetry": true,
"extendInfo": {
"mapKey": {}
}
}
1.5. 根据账户手机号查询账户详情
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountInfoByPhoneNo(com.aliyun.fsi.insurance.sso.dto.AccountPhoneNoQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| phoneNo | string | 手机号 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-info-by-phone-no --data '{
"phoneNo": "nuoyhv"
}'
Response-fields:
| Field | Type | Description | Since |
| data | object | No comments found. | - |
| └─accId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| └─externalId | string | 外部id | - |
| └─displayName | string | 显示名称 | - |
| └─accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| └─accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| └─phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| └─accountStartDt | string | 账户有效期-起期 | - |
| └─accountEndDt | string | 账户有效期-止期 | - |
| └─faceId | string | 人脸识别图片fileid | - |
| └─avatarId | string | 账户图片fileid | - |
| └─branchOrgCode | string | 归属组织编码 | - |
| └─branchOrgName | string | 归属组织名称 | - |
| └─operatingOrgCode | string | 所属经营组织编码 | - |
| └─operatingOrgName | string | 所属经营组织编码 | - |
| └─externalSource | string | 外部id所属来源(应用名) | - |
| └─externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| └─isValid | boolean | 是否有效（true在职，false离职） | - |
| └─beforePhoneNo | string | 之前使用的手机号 | - |
| └─beforeEmail | string | 之前使用的手机号 | - |
| └─gmtModified | string | 修改时间 | - |
| └─twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| pageSize | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
Response-example:
{
"data": {
"accId": "75",
"accountName": "huey.nader",
"externalId": "75",
"displayName": "huey.nader",
"accountRole": "nchqlb",
"accountType": "wk2mz3",
"phoneNo": "lc33x8",
"email": "rutha.pagac@yahoo.com",
"accountStartDt": "vdxae8",
"accountEndDt": "j9gw2a",
"faceId": "75",
"avatarId": "75",
"branchOrgCode": "86060",
"branchOrgName": "huey.nader",
"operatingOrgCode": "86060",
"operatingOrgName": "huey.nader",
"externalSource": "rdkji2",
"externalHead": "f1ec8k",
"isValid": true,
"beforePhoneNo": "i36qx7",
"beforeEmail": "rutha.pagac@yahoo.com",
"gmtModified": "2023-11-15 15:07:58",
"twoFactor": true
},
"pageSize": 10,
"totalCount": 611,
"pageIndex": 1,
"message": {},
"status": 389
}
1.6. 根据钉钉userId获取账号信息
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountInfoByDingUserId(com.aliyun.fsi.insurance.sso.dto.AccountDingUserIdQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| dingUserId | string | 钉钉id | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/cic.aboss.sso.v2.getAccountInfoByDingUserId/2 --data '{
"dingUserId": "58"
}'
Response-fields:
| Field | Type | Description | Since |
| data | object | No comments found. | - |
| └─accId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| └─externalId | string | 外部id | - |
| └─displayName | string | 显示名称 | - |
| └─accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| └─accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| └─phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| └─accountStartDt | string | 账户有效期-起期 | - |
| └─accountEndDt | string | 账户有效期-止期 | - |
| └─faceId | string | 人脸识别图片fileid | - |
| └─avatarId | string | 账户图片fileid | - |
| └─branchOrgCode | string | 归属组织编码 | - |
| └─branchOrgName | string | 归属组织名称 | - |
| └─operatingOrgCode | string | 所属经营组织编码 | - |
| └─operatingOrgName | string | 所属经营组织编码 | - |
| └─externalSource | string | 外部id所属来源(应用名) | - |
| └─externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| └─enabled | boolean | 账户状态(true:启用，false:禁用) | - |
| └─isValid | boolean | 在职离职 true-在职 false-离职 | - |
| └─twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| └─dingUserId | string | 钉钉userId | - |
| └─beforePhoneNo | string | 之前使用的手机号 | - |
| └─beforeEmail | string | 之前使用的邮箱 | - |
| └─gmtModified | string | 修改时间 | - |
| pageSize | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | 1-SUCCESS 2-FAIL 3-UNKNOWN | - |
Response-example:
{
"data": {
"accId": "58",
"accountName": "miriam.mertz",
"externalId": "58",
"displayName": "miriam.mertz",
"accountRole": "jh93n7",
"accountType": "bqk10a",
"phoneNo": "p2xsjy",
"email": "ernesto.farrell@hotmail.com",
"accountStartDt": "r73d61",
"accountEndDt": "955odb",
"faceId": "58",
"avatarId": "58",
"branchOrgCode": "29192",
"branchOrgName": "miriam.mertz",
"operatingOrgCode": "29192",
"operatingOrgName": "miriam.mertz",
"externalSource": "gjchaz",
"externalHead": "2zp3vo",
"enabled": true,
"isValid": true,
"twoFactor": true,
"dingUserId": "58",
"beforePhoneNo": "ejcpia",
"beforeEmail": "ernesto.farrell@hotmail.com",
"gmtModified": "2024-03-06 17:37:53"
},
"pageSize": 10,
"pageIndex": 1,
"totalCount": 75,
"message": {},
"status": 1
}
1.7. 根据账户id查询人脸识别图片
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountFaceImage(com.aliyun.fsi.insurance.sso.dto.AccountFullIdQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accountId | string | 账户id | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-face-image --data '{
"accountId": "75"
}'
Response-fields:
| Field | Type | Description | Since |
| data | object | No comments found. | - |
| └─fileId | string | 文件id | - |
| └─fileName | string | 文件名 | - |
| └─size | int64 | 文件大小 | - |
| └─mimeType | string | 文件mime类型 | - |
| └─gmtCreate | string | 创建（上传）时间 | - |
| └─url | string | url | - |
| └─thnUrl | string | 缩略图url | - |
| └─accountId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| pageSize | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
Response-example:
{
"data": {
"fileId": "75",
"fileName": "huey.nader",
"size": 910,
"mimeType": "mxjkq0",
"gmtCreate": "2023-11-15 15:07:57",
"url": "www.alexandria-pfannerstill.com",
"thnUrl": "www.alexandria-pfannerstill.com",
"accountId": "75",
"accountName": "huey.nader"
},
"pageSize": 10,
"totalCount": 613,
"pageIndex": 1,
"message": {},
"status": 401
}
1.8. 根据账户信息查询账户信息列表(分页，最多返回100条)
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountListByAccount(com.aliyun.fsi.insurance.sso.dto.AccountFullQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| pageSize | int32 | 每页展示条数(最大100条) | true | - |
| pageIndex | int32 | 当前页码 | true | - |
| accId | string | 账户id | false | - |
| displayName | string | 显示名(模糊查询左匹配) | false | - |
| accountType | string | 账户类型(0:内部账户，1:外部账户) | false | - |
| branchOrgCode | string | 归属组织编码(返回当前机构以及子机构) | false | - |
| enabled | boolean | 是否启用(true:启用，false:停用) | false | - |
| isValid | boolean | 在职状态(true:在职，false:离职) | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-list-by-account --data '{
"pageSize": 10,
"pageIndex": 1,
"accId": "160",
"displayName": "paul.hoeger",
"branchOrgCode": "7279",
"enabled": true,
"isValid": true
}'
Response-fields:
| Field | Type | Description | Since |
| data | array | No comments found. | - |
| └─accId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| └─externalId | string | 外部id | - |
| └─displayName | string | 显示名称 | - |
| └─accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| └─accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| └─phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| └─accountStartDt | string | 账户有效期-起期 | - |
| └─accountEndDt | string | 账户有效期-止期 | - |
| └─faceId | string | 人脸识别图片fileid | - |
| └─avatarId | string | 账户图片fileid | - |
| └─branchOrgCode | string | 归属组织编码 | - |
| └─branchOrgName | string | 归属组织名称 | - |
| └─operatingOrgCode | string | 所属经营组织编码 | - |
| └─operatingOrgName | string | 所属经营组织编码 | - |
| └─externalSource | string | 外部id所属来源(应用名) | - |
| └─externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| └─enabled | boolean | 账户状态(true:启用，false:禁用) | - |
| └─isValid | boolean | 是否有效 | - |
| └─twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| └─dingUserId | string | 钉钉userId | - |
| └─beforePhoneNo | string | 之前使用的手机号 | - |
| └─beforeEmail | string | 之前使用的邮箱 | - |
| └─gmtModified | string | 修改时间 | - |
| pageSize | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| message | object | No comments found. | - |
| └─code | string | No comments found. | - |
| └─message | string | No comments found. | - |
| └─errorContext | object | No comments found. | - |
| └─errorStack | array | No comments found. | - |
| └─thirdPartyError | string | No comments found. | - |
| └─errorVariableMap | map | No comments found. | - |
| └─any object | object | any object. | - |
| status | int32 | No comments found. | - |
| needRetry | boolean | No comments found. | - |
| extendInfo | map | No comments found. | - |
| └─any object | object | any object. | - |
Response-example:
{
"data": [
{
"accId": "160",
"accountName": "paul.hoeger",
"externalId": "160",
"displayName": "paul.hoeger",
"accountRole": "w81roe",
"accountType": "xrdirp",
"phoneNo": "rhgzfk",
"email": "spencer.lakin@yahoo.com",
"accountStartDt": "iakvwj",
"accountEndDt": "6w5zo3",
"faceId": "160",
"avatarId": "160",
"branchOrgCode": "7279",
"branchOrgName": "paul.hoeger",
"operatingOrgCode": "7279",
"operatingOrgName": "paul.hoeger",
"externalSource": "yfj8mi",
"externalHead": "d26vov",
"enabled": true,
"isValid": true,
"twoFactor": true,
"dingUserId": "160",
"beforePhoneNo": "eviqhw",
"beforeEmail": "spencer.lakin@yahoo.com",
"gmtModified": "2024-03-26 17:32:42"
}
],
"pageSize": 10,
"pageIndex": 1,
"totalCount": 940,
"message": {
"code": "7279",
"message": "success",
"errorContext": {
"errorStack": [
{
"object": "any object"
}
],
"thirdPartyError": "cw1ity",
"errorVariableMap": {
"mapKey": {}
}
}
},
"status": 393,
"needRetry": true,
"extendInfo": {
"mapKey": {}
}
}
2. 外部账号相关
2.1. 根据外部id+外部来源查询外部账户集合
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountListByExternalIds(com.aliyun.fsi.insurance.sso.dto.AccountExternalIdsQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| externalIds | array | 外部id集合 | true | - |
| externalSource | string | 外部来源 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/account-list-by-external-ids --data '{
"externalIds": [
"3rlyb6"
],
"externalSource": "bjimxy"
}'
Response-fields:
| Field | Type | Description | Since |
| data | array | No comments found. | - |
| └─accId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| └─externalId | string | 外部id | - |
| └─displayName | string | 显示名称 | - |
| └─accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| └─accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| └─phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| └─accountStartDt | string | 账户有效期-起期 | - |
| └─accountEndDt | string | 账户有效期-止期 | - |
| └─faceId | string | 人脸识别图片fileid | - |
| └─avatarId | string | 账户图片fileid | - |
| └─branchOrgCode | string | 归属组织编码 | - |
| └─branchOrgName | string | 归属组织名称 | - |
| └─operatingOrgCode | string | 所属经营组织编码 | - |
| └─operatingOrgName | string | 所属经营组织编码 | - |
| └─externalSource | string | 外部id所属来源(应用名) | - |
| └─externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| └─enabled | boolean | 账户状态(true:启用，false:禁用) | - |
| └─isValid | boolean | 是否有效 | - |
| └─twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | - |
| └─dingUserId | string | 钉钉userId | - |
| └─beforePhoneNo | string | 之前使用的手机号 | - |
| └─beforeEmail | string | 之前使用的邮箱 | - |
| └─gmtModified | string | 修改时间 | - |
| pageSize | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
Response-example:
{
"data": [
{
"accId": "96",
"accountName": "andy.rath",
"externalId": "96",
"displayName": "andy.rath",
"accountRole": "zftidj",
"accountType": "8kp0n7",
"phoneNo": "3d4cju",
"email": "thurman.satterfield@gmail.com",
"accountStartDt": "14fux9",
"accountEndDt": "wfoivp",
"faceId": "96",
"avatarId": "96",
"branchOrgCode": "68766",
"branchOrgName": "andy.rath",
"operatingOrgCode": "68766",
"operatingOrgName": "andy.rath",
"externalSource": "azdcbc",
"externalHead": "7g2mwv",
"enabled": true,
"isValid": true,
"twoFactor": true,
"dingUserId": "96",
"beforePhoneNo": "gwgq4h",
"beforeEmail": "thurman.satterfield@gmail.com",
"gmtModified": "2024-02-29 16:47:06"
}
],
"pageSize": 10,
"totalCount": 612,
"pageIndex": 1,
"message": {},
"status": 714
}
2.2. 根据外部账户来源查询账户信息(分页，最多返回100条)
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#accountListByExternalSource(com.aliyun.fsi.insurance.sso.dto.ExternalSourceQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| pageSize | int32 | 每页展示条数 | true | - |
| pageIndex | int32 | 当前页码 | true | - |
| externalSource | string | 外部来源 | true | - |
| isValid | boolean | 在职状态(true:在职，false:离职，不传返回所有) | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/account-list-by-keyword --data '{
"pageSize": 10,
"pageIndex": 1,
"externalSource": "ey9w96",
"isValid": true
}'
Response-fields:
| Field | Type | Description | Since |
| data | array | No comments found. | - |
| └─accId | string | 账户Id | - |
| └─accountName | string | 登录名称 | - |
| └─externalId | string | 外部id | - |
| └─displayName | string | 显示名称 | - |
| └─accountRole | string | 账户角色(1:普通用户，2:超级管理员) | - |
| └─accountType | string | 账户类型(0:内部账户，1:外部账户) | - |
| └─phoneNo | string | 手机号 | - |
| string | 邮箱 | - | |
| └─accountStartDt | string | 账户有效期-起期 | - |
| └─accountEndDt | string | 账户有效期-止期 | - |
| └─faceId | string | 人脸识别图片fileid | - |
| └─avatarId | string | 账户图片fileid | - |
| └─branchOrgCode | string | 归属组织编码 | - |
| └─branchOrgName | string | 归属组织名称 | - |
| └─operatingOrgCode | string | 所属经营组织编码 | - |
| └─operatingOrgName | string | 所属经营组织编码 | - |
| └─externalSource | string | 外部id所属来源(应用名) | - |
| └─externalHead | string | 外部负责人 | - |
| externalClassification | string | 外部账户业务分类 | - |
| └─isValid | boolean | 是否有效（true在职，false离职） | - |
| └─twoFactor | boolean | 二次认证状态(true:开启，false:关闭) | |
| └─beforePhoneNo | string | 之前使用的手机号 | - |
| └─beforeEmail | string | 之前使用的手机号 | - |
| pageIndex | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageSize | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
| needRetry | boolean | No comments found. | - |
| extendInfo | map | No comments found. | - |
| └─any object | object | any object. | - |
Response-example:
{
"data": [
{
"accId": "57",
"accountName": "stacey.olson",
"externalId": "57",
"displayName": "stacey.olson",
"accountRole": "dzoaj9",
"accountType": "ko3by4",
"phoneNo": "1xyweo",
"email": "devin.hilll@yahoo.com",
"accountStartDt": "hfimy0",
"accountEndDt": "8lrd8l",
"faceId": "57",
"avatarId": "57",
"branchOrgCode": "63368",
"branchOrgName": "stacey.olson",
"operatingOrgCode": "63368",
"operatingOrgName": "stacey.olson",
"externalSource": "t0eqh0",
"externalHead": "lqj3uh",
"isValid": true,
"twoFactor": true,
"beforePhoneNo": "hfaoms",
"beforeEmail": "devin.hilll@yahoo.com"
}
],
"pageIndex": 1,
"totalCount": 185,
"pageSize": 10,
"message": {},
"status": 897,
"needRetry": true,
"extendInfo": {
"mapKey": {}
}
}
2.3. 创建外部账户
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#createExternalAccount(com.aliyun.fsi.insurance.sso.dto.ExternalAccountCmd)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| customCode | string | 自定义编码(账户名=zhex+2位账号来源简称+4位customCode+5位随机流水号) | false | - |
| externalId | string | 外部id | true | |
| displayName | string | 显示名 | true | - |
| joinCompDt | string | 入司日期（yyyy-MM-dd） | false | - |
| leaveCompDt | string | 过期时间(yyyy-MM-dd,不填默认当前时间延后三个月过期) | false | - |
| phoneNo | string | 手机号 | true | - |
| string | 邮箱 | false | - | |
| branchOrgCode | string | 机构编码 | true | - |
| externalHead | string | 外部负责人 | true | - |
| externalSource | string | 外部来源 | true | - |
| externalClassification | string | 外部账户业务分类 | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/create-external-account --data '{
"externalId": "101",
"displayName": "lavona.marks",
"joinCompDt": "vvnq7u",
"leaveCompDt": "czk9gr",
"phoneNo": "nj5lwe",
"email": "shaun.leffler@yahoo.com",
"branchOrgCode": "24011",
"externalHead": "lmkzf5",
"externalSource": "j85z4l"
}'
Response-example:
string
2.4. 修改外部账户
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#updateExternalAccount(com.aliyun.fsi.insurance.sso.dto.ExternalAccountUpdateCmd)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| externalId | string | 外部id | true | - |
| displayName | string | 显示名 | false | - |
| accountStartDt | string | 入司日期（yyyy-MM-dd） | false | - |
| accountEndDt | string | 过期时间(yyyy-MM-dd,不填默认当前时间延后三个月过期) | false | - |
| phoneNo | string | 手机号 | false | - |
| string | 邮箱 | false | - | |
| branchOrgCode | string | 机构编码 | false | - |
| externalHead | string | 外部负责人 | false | - |
| externalSource | string | 外部来源 | true | - |
| externalClassification | string | 外部账户业务分类 | false |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/update-external-account --data '{
"externalId": "31",
"displayName": "miesha.gibson",
"accountStartDt": "957371",
"accountEndDt": "4vt22r",
"phoneNo": "cr2qbv",
"email": "ignacio.cremin@yahoo.com",
"branchOrgCode": "98659",
"externalHead": "6m5oqa",
"externalSource": "bu5mxw"
}'
Response-example:
string
2.5. 离职外部账户
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#invalidExternalAccount(com.aliyun.fsi.insurance.sso.dto.ExternalAccountInvalidCmd)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| externalId | string | 外部id | true | - |
| externalSource | string | 外部来源 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/invalid-external-account --data '{
"externalId": "75",
"externalSource": "gn75ie"
}'
Response-fields:
| Field | Type | Description | Since |
| data | object | No comments found. | - |
| pageSize | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
Response-example:
{
"data": "u7jzxe",
"pageSize": 10,
"totalCount": 391,
"pageIndex": 1,
"message": {},
"status": 438
}
2.6. 返聘外部账户
Description: com.aliyun.fsi.insurance.sso.api.AccountRpcFacade#rehiredExternalAccount(com.aliyun.fsi.insurance.sso.dto.ExternalAccountRehiredCmd)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| externalId | string | 外部id | true | - |
| accountStartDt | string | 入司日期（yyyy-MM-dd） | true | - |
| accountEndDt | string | 离司时间(yyyy-MM-dd) | true | - |
| phoneNo | string | 手机号 | true | - |
| externalSource | string | 外部来源 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/rehired-external-account --data '{
"externalId": "75",
"accountStartDt": "urco0u",
"accountEndDt": "7vnz00",
"phoneNo": "gkgr4v",
"externalSource": "4w89pv"
}'
Response-fields:
| Field | Type | Description | Since |
| data | object | No comments found. | - |
| pageSize | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
Response-example:
{
"data": "hl1bu2",
"pageSize": 10,
"totalCount": 61,
"pageIndex": 1,
"message": {},
"status": 758
}
3. 账号扩展属性
3.1. 添加账户扩展属性
Description: com.aliyun.fsi.insurance.sso.impl.AccountExtendRpcFacadeImpl#addAccountExtend(com.aliyun.fsi.insurance.sso.dto.AccountExtendAddCmd)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accId | string | 账户id | true | - |
| key | string | 扩展key | true | - |
| value | string | 扩展value | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/add-account-extend --data '{
"accId": "75",
"key": "dxkqt9",
"value": "xce6rt"
}'
Response-example:
true
3.2. 修改账户扩展属性
Description: com.aliyun.fsi.insurance.sso.api.AccountExtendRpcFacade#updateAccountExtend(com.aliyun.fsi.insurance.sso.dto.AccountExtendUpdateCmd)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accId | string | 账户id | true | - |
| key | string | 扩展key | true | - |
| value | string | 扩展value | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/update-account-extend --data '{
"accId": "75",
"key": "g2wsmz",
"value": "51fhx7"
}'
Response-example:
true
3.3. 删除账户扩展属性
Description: com.aliyun.fsi.insurance.sso.api.AccountExtendRpcFacade#deleteAccountExtend(com.aliyun.fsi.insurance.sso.dto.AccountExtendDeleteCmd)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accId | string | 账户id | true | - |
| key | string | 扩展key | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/delete-account-extend --data '{
"accId": "75",
"key": "3swaym"
}'
Response-example:
true
3.4. 查询账户扩展属性列表
Description: com.aliyun.fsi.insurance.sso.api.AccountExtendRpcFacade#queryAccountExtends(com.aliyun.fsi.insurance.sso.dto.AccountIdsQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accIds | array | 账户id集合（最多50条记录） | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/query-account-extends --data '{
"accIds": [
"ie6hd4"
]
}'
Response-fields:
| Field | Type | Description | Since |
| Map<String, Map<String, String>> | object | 键值对集合 {“accId”: {“key1”: “value1”,“key2”: “value2” }} | - |
Response-example:
{
"1234561": {
"key1": "value111111",
"key11": "value1111111"
},
"123456": {
"key11": "value11",
"key": "value"
}
}
3.5. 根据扩展key和扩展value查询账户id集合(分页)
Description: com.aliyun.fsi.insurance.sso.api.AccountExtendRpcFacade#queryAccountIdsByKeyAndValue(com.aliyun.fsi.insurance.sso.dto.AccountExtendKeyAndValueQry)
Body-parameters:
| Parameter | Type | Description | Required | Since |
| pageSize | int32 | 每页展示条数(最大100条) | true | - |
| pageIndex | int32 | 当前页码 | true | - |
| key | string | 拓展key | true | - |
| value | string | 拓展value | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/query-account-extends-by-key-and-value --data '{
"pageSize": 10,
"pageIndex": 1,
"key": "d21hkw",
"value": "xsgmjv"
}'
Response-fields:
| Field | Type | Description | Since |
| data | array | No comments found. | - |
| pageIndex | int32 | No comments found. | - |
| totalCount | int32 | No comments found. | - |
| pageSize | int32 | No comments found. | - |
| message | object | No comments found. | - |
| status | int32 | No comments found. | - |
| needRetry | boolean | No comments found. | - |
| extendInfo | map | No comments found. | - |
| └─any object | object | any object. | - |
4. 签名
4.1.查询签名
URL: /platform/api/aboss/sso/rpc/sign/query-signature
Type: POST
com.aliyun.fsi.insurance.sso.api.AccountSignatureRpcFacade#querySignatureByAccountId(AccountIdQry)
Content-Type: application/json; charset=utf-8
Description: 查询签名
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accId | string | 账户id | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/sign/query-signature --data '{
"accId": "128"
}'
Response-fields:
| Field | Type | Description | Since |
| accountId | string | 账户Id | - |
| displayName | string | 账户 名 | - |
| sign | string | 签名 | - |
Response-example:
{
"accountId": "128",
"displayName": "booker.stanton",
"sign": "ac1qac"
}
4.2.存储签名
URL: /platform/api/aboss/sso/rpc/sign/save-signature
Type: POST
com.aliyun.fsi.insurance.sso.api.AccountSignatureRpcFacade#saveSignature(InsertAccountSignCmd)Content-Type: application/json; charset=utf-8
Description: 存储签名
Body-parameters:
| Parameter | Type | Description | Required | Since |
| accountId | string | 账号Id | true | - |
| sign | string | 账号签名 | true | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i /platform/api/aboss/sso/rpc/sign/save-signature --data '{
"accountId": "128",
"sign": "ke0nwe"
}'
Response-example:
true
三、常见问题及处理方法
1.如果调用附录中的几个接口可能会报如下错误：
REQUESTSOURCE不存在,非法请求!
访问路由REQUESTSOURCE未配置!
解决方法：见附录
四、附录
2.6-2.10、2.14、2.15有权限控制，需填写如下申请单
| 访问方法 | 请求来源 | 备注 |
| com.aliyun.fsi.insurance.sso.impl.AccountRpcFacadeImpl#accountListByKeyword | aboss-sso | rpc请求填写的是应用名 |
| com.aliyun.fsi.insurance.sso.impl.AccountRpcFacadeImpl#accountListByKeyword | /support/basicData/association/query | http请求填写的是referer |