ユーザを削除するためのAPI仕様です。
APIを使用してレコードを削除する事ができます。
■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。
■URL
下記のURLを使用します。
{Id}は削除するレコードのユーザーIdに置換してください。
https://ks01.shelterdb.net/api/users/{Id}/delete
■リクエスト
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Type は'application/json'、文字コードはUTF-8を使用してください。
{
"ApiVersion": 1.1,
"ApiKey": "XXXXXXXXXX..."
}
■レスポンス
下記の形式のjsonデータが返却されます。
{
"Id": 12345,
"StatusCode": 200,
"Message": "\" 指定したユーザ名 \" を削除しました。"
}
※"Message"
内の\
表記はバックスラッシュです。