cybozu.com 共通 API ドキュメント

ユーザーの利用サービスを取得する

目次

ユーザーの利用サービスを取得する

ユーザーの利用サービスを取得します。

CSV ファイルにエクスポートする API の詳細は、 ユーザーの利用サービスをエクスポートする を参照してください。

URL

https://sample.cybozu.com/v1/users/services.json

HTTP メソッド

GET

必要なアクセス権

なし

リクエスト

パラメーター
パラメーター名 型 必須 説明
codes 配列（文字列） 省略可 ユーザーのログイン名の一覧
省略すると、最大 100 件のユーザー情報を取得します。
size 数値 省略可 取得するユーザーの件数
1 から 100 まで指定できます。省略すると 100 が設定されます。
offset 数値 省略可 取得するユーザーの先頭からスキップする数
0 から無限大の数値を指定できます。
省略すると、 0 が設定されます。
リクエストの例
URL

https://sample.cybozu.com/v1/users/services.json?codes[0]=sato-noboru&codes[1]=kato-misaki

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は User API の共通仕様 を参照してください。

レスポンス

プロパティ
プロパティ名 型 説明
users 配列 ユーザ情報の一覧
並び順は、users[].id の昇順です。
users[].code 文字列 ユーザーのログイン名
users[].services 配列（文字列） ユーザーの利用サービスの一覧
次の値が返ります。
  • kintone ：kintone
  • garoon：Garoon
  • office：サイボウズ Office
  • mailwise：メールワイズ
  • secure_access：セキュアアクセス
利用サービスが設定されていない場合、空配列が返ります。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "users": [
    {
      "code": "sato-noboru",
      "services": ["garoon", "kinotne"]
    },
    {
      "code": "kato-misaki",
      "services": ["kintone"]
    }
  ]
}

サンプルコード

curl を使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/v1/users/services.json?codes%5B0%5D=sato-noboru&codes%5B1%5D=kato-misaki' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='

制限事項

  • Administrator のデータは出力できません。