外部 ID に基づいて、Employee Identity and Access Management (EIAM) アカウントの ID を照会します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByExternalId HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンスの ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
必須 |
アプリケーションの ID。 |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報。形式: Bearer ${access_token}。例: Bearer ATxxxx。 |
Bearer AT8csE2seYxxxxxij |
| body |
object |
任意 |
リクエストボディ。 |
|
| userExternalId |
string |
必須 |
アカウントの外部 ID。 |
xxx001 |
| userSourceType |
string |
必須 |
アカウントのソースタイプ。有効な値:
|
build_in |
| userSourceId |
string |
必須 |
アカウントのソース ID。アカウントが IDaaS で作成された場合、そのソース ID は IDaaS インスタンスの ID です。アカウントがインポートされた場合、そのソース ID はソース内の企業 ID です。例えば、アカウントが DingTalk からインポートされた場合、そのソース ID は DingTalk 内の企業の corpId 値です。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| userId |
string |
アカウントの ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
例
成功レスポンス
JSONJSON
{
"userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。