個人情報の削除
指定されたユーザの個人情報を削除します。
この API ではソーシャルPLUS ID や過去のログイン履歴など、個人情報以外の情報は削除されません。
GET /api/delete_profile
注記
リクエストパラメータに casual
を指定せずに実行した場合、そのユーザの「個人情報取得禁止の状態」が有効化され、以降は個人情報が取得されなくなります。
再度、個人情報を取得するためには 個人情報取得禁止の解除(grant_profile)API を利用して「個人情報取得禁止の状態」を無効化する必要があります。
注記
個人情報が削除されている場合、「個人情報取得禁止の状態」を無効化後に該当ユーザが再ログインするまでは個人情報を取得できません。
リクエストパラメータ
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
key | string | ○ | API キー |
identifier | string | △ | 対象のソーシャルPLUS ID |
primary_key | string | △ | 対象のお客様サービス側ユーザID |
casual | boolean | true の場合、個人情報取得禁止の状態を変更しません |
エラーコード
HTTP Status | Code | Message | 説明 |
---|---|---|---|
401 | 1 | Invalid API key or key not found. | API キーが指定されていないか、存在しないAPIキーです |
400 | 5 | Required parameter not found. | 必須のパラメーターが指定されていません |
400 | 6 | Invalid parameter. | パラメーターに間違いがあります |
404 | 7 | Entity not found. | 指定されたユーザが存在しません |
レスポンス
キー | 型 | 最大長 | 説明 |
---|---|---|---|
status | string | 15 | リクエストが成功したかどうか(ok または failed ) |
レスポンス例
{
"status": "ok"
}
実行サンプル
curl -X GET https://api.socialplus.jp/api/delete_profile -G \
-d key={API Key} \
-d primary_key={Primary Key}