ログインプロバイダの紐付け削除
ソーシャルPLUS ユーザに紐付いたログインプロバイダの紐付けを削除します。
紐付け解除されたログインプロバイダから取得した個人情報も合わせて削除され、残ったログインプロバイダから取得した個人情報により、このユーザの個人情報が再作成されます。
GET /api/dissociate
注記
この API の実行で、対象のソーシャルPLUS ユーザに紐付くログインプロバイダが1つも存在しなくなる場合は "Unacceptable operation." エラーとなり、紐付け解除は行われません。
エラーにさせず強制的に削除する場合は nowarn
パラメータに true
を指定してください。
注記
この API の実行時にユーザの個人情報の再作成したくない場合は nomerge
パラメータに true
を指定してください。
ユーザの個人情報はユーザが再ログインするたびに再作成されるため、このパラメータを利用しても、紐付けを削除したログインプロバイダから取得していた個人情報が永続的に保持されるわけではありません。
警告
紐付けの解除後、ユーザが解除対象のログインプロバイダで再度ログインしようとした場合は、新しいソーシャルPLUS ID が発行され新規ユーザとして扱われる可能性があります。
リクエストパラメータ
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
key | string | ○ | API キー |
identifier | string | △ | 対象のソーシャルPLUS ID |
primary_key | string | △ | 対象のお客様サービス側ユーザID |
target_provider | string | ○ | 対象のログインプロバイダ。, 区切りで複数指定可能 |
nowarn | boolean | true の場合、ユーザに紐付くログインプロバイダが存在しなくなる場合でもエラーを発生させません | |
nomerge | boolean | true の場合、紐付け削除後にユーザの個人情報を更新しません |
エラーコード
HTTP Status | Code | Message | 説明 |
---|---|---|---|
401 | 1 | Invalid API key or key not found. | API キーが指定されていないか、存在しないAPIキーです |
500 | 3 | Operation failed. | ユーザ情報のマージに失敗しました |
400 | 5 | Required parameter not found. | 必須のパラメーターが指定されていません |
400 | 6 | Invalid parameter. | パラメーターに間違いがあります |
404 | 7 | Entity not found. | 指定されたユーザが存在しません |
404 | 9 | Specified provider not associated with this user. | このユーザに指定されたログインプロバイダのログイン情報がありません |
400 | 17 | Unacceptable operation. | 処理を実行するにはパラメーターで強制動作するように指定する必要があります |
レスポンス
キー | 型 | 最大長 | 説明 |
---|---|---|---|
status | string | 15 | リクエストが成功したかどうか(ok または failed ) |
dissociated | array of string | 255 | 紐付けを削除したログインプロバイダ |
レスポンス例
{
"status": "ok",
"dissociated": [
"facebook",
"twitter"
]
}
実行サンプル
curl -X GET https://api.socialplus.jp/api/dissociate -G \
-d key={API Key} \
-d primary_key={Primary Key} \
-d target_provider=facebook,twitter