メインコンテンツまでスキップ

個人情報の削除

指定されたユーザーの個人情報を削除します。

この API ではソーシャルPLUS ID（ユーザーデータ）そのものは削除されません。

GET /api/delete_profile
注記

リクエストパラメータに casual=true を指定せずに実行した場合、そのユーザーの「個人情報保管禁止」の状態が有効化され、以降は個人情報が保管されなくなります。

再度、個人情報を保管するためには 個人情報保管禁止の解除（grant_profile）API を利用して「個人情報保管禁止」の状態を無効化する必要があります。

注記

個人情報の削除後、「個人情報保管禁止」の状態でも scope の指定と許可が得られていればソーシャルログイン時の ID Token や Access Token を用いた Userinfo エンドポイントによる個人情報の取得は可能です。

リクエスト​

Path パラメーター​

パラメータ名型必須説明
keystring○Web API キー
identifierstring※対象のソーシャルPLUS ID
primary_keystring※対象のお客様サービス側ユーザID
casualbooleantrue の場合、個人情報保管禁止の状態を変更しません

※ identifier または primary_key のいずれかを指定（必須）。詳しくは ユーザーの特定 を参照

リクエストサンプル​

curl -X GET https://api.socialplus.jp/api/delete_profile \
  -d key={Web API キー} \
  -d primary_key={お客様サービス側のユーザID}

エラーレスポンス​

関連: 共通エラー定義

エラーコード​

HTTP ステータスコードCodeMessage説明
401（Unauthorized）1Invalid API key or key not found.API キーが指定されていないか、存在しないAPIキーです
400（Bad Request）5Required parameter not found.必須のパラメーターが指定されていません
400（Bad Request）6Invalid parameter.パラメーターに間違いがあります
404（Not Found）7Entity not found.指定されたユーザーが存在しません

成功レスポンス​

リクエストに成功すると、HTTP ステータスコード 200 OK と、JSON オブジェクトを返します。

成功時のレスポンス例
HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "ok"
}

レスポンスパラメーター​

パラメータ名型最大長説明
statusstring15リクエストが成功したかどうか（ok または failed）