調用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 | 服務器內部錯誤 |