印刷する

ユーザー

users > add_ext_auth_provider

既存のユーザーに外部認証プロバイダを追加します。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gousersAPIセクション
doadd_ext_auth_providerAPIアクション
iqUser IDINTER-STREAMのユーザーID

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=users&do=add_ext_auth_provider&iq={user_id}&{required information}
POST変数

以下のPOST変数は必須です。

変数値説明
ext_provider (string) auth_provider 認証プロバイダの名前
利用可能な値："twitter", "facebook", "oauth", "google", "openid"
ext_user_id (string) external_user_id 外部認証プロバイダからのユーザーID

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok：外部認証プロバイダー情報がユーザーに正常に追加された場合

{
    "ok": "External Auth Provider was added successfully for the User"
}

指定されたユーザーIDを持つユーザーを見つけることができなかった場合など、リクエストが失敗した場合のレスポンス

{
    "error": "USER_NOT_FOUND",
    "error_long": "It was not possible to find an User with the supplied ID"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。

・REQUEST_ERROR | Wrong External Auth Provider Name
想定外の外部認証プロバイダ名です（利用可能な値を確認してください）。

・REQUEST_ERROR | No User ID, from the External Auth Provider, was supplied
"ext_user_id"が空欄です。

・USER_NOT_FOUND | It was not possible to find an User with the supplied Login/Username
指定されたログインIDと紐付くユーザーが見つかりません。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "add_ext_auth_provider",
					"iq"        => 38
					);

// POST変数
$POST_VARS = array( 
					"ext_provider"    => "facebook",
					"ext_user_id"     => "sdf7d8f7sdf"
					);