调用GetUserIdByUserExternalId接口,通过账户外部ID获取EIAM账户ID。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByExternalId
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Authorization | string | 是 | 认证信息。 格式:Bearer ${access_token}。 示例:Bearer ATxxxx。 | Bearer AT8csE2seYxxxxxij |
instanceId | string | 是 | 实例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
applicationId | string | 是 | 应用 ID | app_mkv7rgt4d7i4u7zqtzev2mxxxx |
body | object | 否 | 请求 body。 | |
userExternalId | string | 是 | 账户外部 ID。 | xxx001 |
userSourceType | string | 是 | 账户来源类型,取值可选范围:
| build_in |
userSourceId | string | 是 | 账户来源 ID。 自建类型(build_in)值为实例 ID,非自建类型,为对应企业 ID,比如钉钉,对应的 corpId。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
返回参数
示例
正常返回示例
JSON
格式
{
"userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
错误码
HttpCode | Error Code | 错误信息 | 说明 |
---|---|---|---|
400 | invalid_token | Access token is not valid | token 无效 |
404 | application_not_found | Application id not found: app_mkv7rgt4d7i4u7zqtzev2mxxxx | 应用不存在 |
403 | application_disabled | Application is disabled | 应用处于禁用状态 |
403 | application_api_disabled | Application api invoke disabled | 应用 API 未开放 |
403 | permission_denied | Require scopes: [urn:alibaba:idaas:scope:user:manager_all] | 缺少 API 授权信息 |
400 | MissingParameter.UserExternalId | The specified parameter: UserExternalId is required! | 缺少 UserExternalId 参数 |
400 | MissingParameter.UserSourceType | The specified parameter: UserSourceType is required! | 缺少 UserSourceType 参数 |
400 | MissingParameter.UserSourceId | The specified parameter: UserSourceId is required! | 缺少 UserSourceId 参数 |
400 | ResourceNotFound.UserId | The specified UserId resource: %s not found. | 账户 ID 不存在 |
500 | Internal Server Error | Internal Server Error | 服务器内部错误 |