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

ユーザーが所属するグループ（ロール）を取得する

目次

ユーザーが所属するグループ（ロール）を取得する

固定リンクがコピーされました

ユーザーが所属するグループ（ロール）を取得します。

CSVファイルをエクスポートするAPIの詳細は、 ユーザーが所属するグループ（ロール）をエクスポートするを参照してください。

URL

固定リンクがコピーされました

https://sample.cybozu.com/v1/user/groups.json

HTTP メソッド

固定リンクがコピーされました

GET

必要なアクセス権

固定リンクがコピーされました

なし

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
code 文字列 必須 ユーザーのログイン名
リクエストの例
URL

https://sample.cybozu.com/v1/user/groups.json?code=sato-noboru

ヘッダー
1
2
3

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

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

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 内容
groups 配列 ユーザーが所属するグループ（ロール）の一覧
詳細は Group 型を参照してください。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "groups": [
    {
      "id": "1",
      "code": "recruit2022",
      "name": "2022年度採用プロジェクト",
      "description": "2022年度採用プロジェクト"
    },
    {
      "id" : "7532782697181632513",
      "code" : "everyone",
      "name" : "Everyone",
      "description" : ""
    }
  ]
}

サンプルコード

固定リンクがコピーされました

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

curl -X GET 'https://sample.cybozu.com/v1/user/groups.json?code=sato-noboru' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='

制限事項

固定リンクがコピーされました

  • kintoneのゲストユーザーは取得できません。