ログインユーザーの情報を取得する
画面を表示しているログインユーザーの情報を取得できます。
関数
garoon.base.user.getLoginUser()
使用可能なバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 4.10.0 以降
引数
なし
返り値
- ログインユーザーのユーザー情報を保持するオブジェクト
オブジェクトの内容
| パラメータ | 型 | 値と説明 |
|---|---|---|
| id | 文字列 | ユーザー ID |
| garoonId | 文字列 | Garoon ユーザー ID |
| code | 文字列 |
ログイン名 取得するには、システム管理の「ユーザー情報の項目」に関する設定で、「ログイン名」に対して「公開する」のチェックボックスを選択する必要があります。 |
| name | 文字列 | 表示名 「個人設定 > 画面 > 一般設定 > ユーザー名の後ろに表示する情報」で「優先する組織」を設定した場合、「表示名; 所属組織」の形で返却されます。 |
| 文字列 | メールアドレス | |
| url | 文字列 | URL |
| phone | 文字列 | 電話番号 |
| timezone | 文字列 | アカウント設定で設定したタイムゾーン |
| language | 文字列 | アカウント設定で設定した言語
|
サンプル（クラウド版）
利用できる画面
ポップアップ画面を除く全ての画面で利用できます。
注意事項
- ポップアップ画面には対応していません。
- ワークフローの申請フォームのプレビュー画面では選択されたユーザーが対象です。
- ポータルのプレビュー画面ではログインユーザーが対象です。
このAPIでユーザー情報を取得したとき、"name"プロパティが "ユーザー漢字名; 所属組織名" となるケースがあるようです。
どのような条件で組織名が追加されるのか、仕様をご教示ください。
tohosaku 様
お世話になっております。
cybozu developer network 運営局です。
ご質問いただいたケースですが、仕様として、
Garoon の「個人設定 > 画面 > 一般設定 > ユーザー名の後ろに表示する情報」にて
「優先する組織」を設定した場合に組織名が表示されます。
下記ヘルプサイトにて、所属組織の設定手順が記載されておりますのでご覧ください。
https://jp.cybozu.help/g/ja/admin/system/screen/initial.html#admin_system_screen_initial_02