個人情報保管禁止の解除
指定されたユーザーの「個人情報保管禁止」の状態を無効化します。
GET /api/grant_profile
注記
個人情報が削除されている場合、「個人情報保管禁止」の状態を無効化後に該当ユーザーが再ログインするまでは個人情報が保管されません。
リクエスト
Path パラメーター
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
key | string | ○ | API キー |
identifier | string | ※ | 対象のソーシャルPLUS ID |
primary_key | string | ※ | 対象のお客様サービス側ユーザID |
※ identifier
または primary_key
のいずれかを指定(必須)。詳しくは ユーザーの特定 を参照
リクエストサンプル
curl -X GET https://api.socialplus.jp/api/grant_profile \
-d key={Web API キー} \
-d primary_key={お客様サービス側のユーザID}
エラーレスポンス
関連: 共通エラー定義
エラーコード
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. | 指定されたユーザーが存在しません |
成功レスポンス
リクエストに成功すると、HTTP ステータスコード 200 OK と、JSON オブジェクトを返します。
成功時のレスポンス例
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ok"
}
レスポンスパラメーター
パラメータ名 | 型 | 最大長 | 説明 |
---|---|---|---|
status | string | 15 | リクエストが成功したかどうか(ok または failed ) |