ユーザーが所属するグループ（ロール）を取得する
固定リンクがコピーされました
ユーザーが所属するグループ（ロール）を取得する
固定リンクがコピーされました
ユーザーが所属するグループ（ロール）を取得します。
ユーザーの情報を元にした分岐処理や、ユーザーの情報を表示するUIの作成などに利用できます。
ゲストスペースで実行する場合、「Everyone/Administrator」のグループだけ返ります。
このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。
関数
固定リンクがコピーされました
PC／モバイル
kintone.user.getGroups(code)
引数
固定リンクがコピーされました
| 引数名 | 型 | 必須 | 説明 |
|---|---|---|---|
| code | 文字列 | 省略可 | 情報を取得するユーザーのログイン名 省略した場合はログインユーザーの情報を取得します。 |
戻り値
固定リンクがコピーされました
戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に次の要素をもつオブジェクトの配列が取得できます。
| プロパティ名 | 型 | 値と説明 |
|---|---|---|
| id | 文字列 | グループID |
| code | 文字列 | グループコード |
| name | 文字列 | グループ名 |
利用できる画面
固定リンクがコピーされました
PC／モバイル
利用できる画面は、全体カスタマイズの適用画面に従います。
kintone全体のカスタマイズが適用される画面
ただし、次の画面では利用できません。
- 検索画面
- アプリストア
- プラグイン設定画面
注意事項
固定リンクがコピーされました
このAPIは実行時にサーバーからデータを取得します。取得したデータは画面遷移が発生するまでキャッシュされます。
ユーザーごとに1分当たり50回を超えるサーバーからのデータの取得があった場合、戻り値のPromiseオブジェクトが拒否（rejected）されます。
- ユーザーが所属するグループの詳細を取得したい場合には、次のAPIを利用してください。
グループを取得する