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