他ユーザーの属性の読み込み

ユーザーのユーザー名、メールアドレス、もしくは電話番号を指定することで、該当ユーザーの属性にアクセスできます。

読み取り可能なユーザー属性

他ユーザーの属性は読み取り操作のみ可能です。読み取り可能なユーザー属性は、アプリケーションの設定（"ユーザー情報の全データを開示" オプション）によって決まります。詳細はユーザー属性をご覧ください。

アプリケーション設定の変更方法はユーザー属性の開示範囲の設定をご覧ください。

ユーザー属性を取得する

ユーザー名を指定してユーザー属性を取得

ユーザー名指定によるユーザー属性取得の例を以下に挙げます。

curl -v -X GET \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/LOGIN_NAME:{USERNAME}"

メールアドレスを指定してユーザー属性を取得

メールアドレス指定によるユーザー属性取得の例を以下に挙げます。指定するメールアドレスは認証済みである必要があります。

curl -v -X GET \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/EMAIL:{EMAIL_ADDRESS}"

電話番号を指定してユーザー属性を取得

電話番号指定によるユーザー属性取得の例を以下に挙げます。指定する電話番号は認証済みである必要があります。また電話番号は、+と国コードから始まる国際電話番号を指定してください。

curl -v -X GET \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/PHONE:{PHONE_NUMBER}"

ユーザー ID を指定してユーザー属性を取得

ユーザー ID 指定によるユーザー属性取得の例を以下に挙げます。

curl -v -X GET \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/{USER_ID}"

Kii Cloud からの応答

いずれのケースにおいても、Kii Cloud は次のようにユーザー属性を返します。

< Content-Type: application/vnd.kii.UserDataRetrievalResponse+json
<
{
  "userID" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "loginName" : "Test003",
  "displayName" : "Person Test003",
  "_disabled": false
}

アプリケーション設定パラメータ exposeFullUserDataToOthers が true に設定されている場合、全てのユーザー属性が返されます。