ユーザーを無効化する

アプリ管理者トークンを使うとユーザーの無効化ができます。無効化されたユーザーはログインできなくなり、このユーザーに対して払いだされていた全てのユーザートークンが無効化されます。また、無効化されたユーザーはパスワードのリセットができなくなります。

ユーザーの無効化/有効化は "disabled" 属性で制御します。属性値を "true" にするとこのユーザーは無効化され、"false" にすると再び有効化されます。

以下に、ユーザーを無効化する例を挙げます。例にもあるように、ここではアプリ管理者トークンを指定する必要があります。アプリ管理者トークン取得方法は「アプリ管理者向け機能」を参照してください。

curl -v -X PUT \
  -H "Authorization: Bearer {APP_ADMIN_TOKEN}" \
  -H "Content-Type: application/vnd.kii.UserStatusUpdateRequest+json" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/{USER_ID}/status" \
  -d '{"disabled": true}'

ユーザーの無効化に成功すると、Kii Cloud は次のように応答します。

HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Mon, 14 May 2012 18:41:45 GMT

なお、ユーザーが無効化されていても、他のユーザーの検索機能（Android SDK の KiiUser.findUserByUserName メソッドなど）、グループのメンバー一覧機能などでの参照操作は制限されません。無効化されている場合に参照操作を失敗させたい場合は、アプリからクライアント SDK を通してユーザー属性 "disabled" を確認し、false の場合は無効化されているものとして扱うといった対応ができます。