GetUserIdByUserExternalId - 通过账户外部ID获取EIAM账户ID

调用GetUserIdByUserExternalId接口,通过账户外部ID获取EIAM账户ID。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByExternalId

请求参数

名称类型必填描述示例值
Authorizationstring

认证信息。 格式:Bearer ${access_token}。 示例:Bearer ATxxxx。

Bearer AT8csE2seYxxxxxij
instanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
applicationIdstring

应用 ID

app_mkv7rgt4d7i4u7zqtzev2mxxxx
bodyobject

请求 body。

userExternalIdstring

账户外部 ID。

xxx001
userSourceTypestring

账户来源类型,取值可选范围:

  • build_in:自建。
  • ding_talk:钉钉导入。
  • ad:AD 导入。
  • ldap:LDAP 导入
build_in
userSourceIdstring

账户来源 ID。 自建类型(build_in)值为实例 ID,非自建类型,为对应企业 ID,比如钉钉,对应的 corpId。

idaas_ue2jvisn35ea5lmthk267xxxxx

返回参数

名称类型描述示例值
object

响应结果。

userIdstring

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx

示例

正常返回示例

JSON格式

{
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-24API 内部配置变更,不影响调用查看变更详情

错误码

HttpCodeError Code错误信息说明
400invalid_tokenAccess token is not validtoken 无效
404application_not_foundApplication id not found: app_mkv7rgt4d7i4u7zqtzev2mxxxx应用不存在
403application_disabledApplication is disabled应用处于禁用状态
403application_api_disabledApplication api invoke disabled应用 API 未开放
403permission_deniedRequire scopes: [urn:alibaba:idaas:scope:user:manager_all]缺少 API 授权信息
400MissingParameter.UserExternalIdThe specified parameter: UserExternalId is required!缺少 UserExternalId 参数
400MissingParameter.UserSourceTypeThe specified parameter: UserSourceType is required!缺少 UserSourceType 参数
400MissingParameter.UserSourceIdThe specified parameter: UserSourceId is required!缺少 UserSourceId 参数
400ResourceNotFound.UserIdThe specified UserId resource: %s not found.账户 ID 不存在
500Internal Server ErrorInternal Server Error服务器内部错误