Userオブジェクト

次のオブジェクトは、userAPIに直接関連しています。

ユーザー

ユーザーオブジェクトには、以下のプロパティがあります。

プロパティ タイプ 説明
userid ID ユーザーのID。

プロパティの動作:
- 読み取り専用
- 更新操作では必須
username string ユーザー名。

プロパティの動作:
- 作成操作では必須
- ユーザーがユーザーディレクトリにリンクされており（userdirectoryidに有効な「0」以外の値が設定されている）、ユーザーディレクトリのプロビジョニングステータスが有効で（ユーザーディレクトリオブジェクトのprovision_statusに「1」が設定されている）、LDAPまたはSAMLプロビジョニングの認証ステータスが有効な場合（認証オブジェクトのldap_jit_statusに「設定済みのLDAP IdPに対して有効」が設定されている、またはs aml_jit_statusに「設定済みのSAML IdPに対して有効」が設定されている）、プロビジョニングされたユーザーでは読み取り専用
passwd string ユーザーのパスワード。

ユーザーがユーザーディレクトリにリンクされている場合、このパラメータの値には空の文字列を指定できます。

プロパティの動作:
- 書き込み専用
roleid ID ユーザーのロールのID。

ロールのないユーザーは、LDAP/SAML情報がZabbixで設定されたユーザーグループのマッピングと一致する場合に限り、LDAPまたはSAML認証を使用してZabbixにログインできます。
attempt_clock timestamp 最後に失敗したログイン試行の時刻。

プロパティの動作:
- 読み取り専用
attempt_failed integer 最近のログイン失敗回数。

プロパティの動作:
- 読み取り専用
attempt_ip string 最後に失敗したログイン試行元のIPアドレス。

プロパティの動作:
- 読み取り専用
autologin integer 自動ログインを有効にするかどうか。

指定可能な値:
0 - (デフォルト) 自動ログイン無効;
1 - 自動ログイン有効。
autologout string ユーザーセッションの有効期間。秒数（例: 1、60、300）、または時間のサフィックス付きの値（例: 30s、1m、2h）を指定します。0sに設定すると、セッションは期限切れになりません。

デフォルト: 15m。
lang string ユーザーの言語の言語コード（例: en_US）。

デフォルト: default - システムのデフォルト。
name string ユーザーの名。
provisioned integer ユーザーがプロビジョニングされているかどうか。

指定可能な値:
0 - プロビジョニングされていない;
1 - プロビジョニング済み。

プロパティの動作:
- 読み取り専用
refresh string 自動更新の間隔。秒数（例: 1、60、300）、または時間のサフィックス付きの値（例: 30s、1m、1h）を指定します。

デフォルト: 30s。
rows_per_page integer 1ページに表示するオブジェクトの行数。

デフォルト: 50。
surname string ユーザーの姓。
theme string ユーザーのテーマ。

指定可能な値:
default - (デフォルト) システムのデフォルト;
blue-theme - 青;
dark-theme - ダーク;
hc-light - ハイコントラスト（明るい）;
hc-dark - ハイコントラスト（暗い）。
ts_provisioned timestamp 最後のプロビジョニング操作が実行された時刻。

プロパティの動作:
- 読み取り専用
- Super adminタイプのユーザーでサポート
url string ログイン後にユーザーをリダイレクトするページのURL。
userdirectoryid ID ユーザーがリンクされているユーザーディレクトリのID。

プロビジョニング（作成または更新）、およびユーザーディレクトリにリンクされたユーザーのログインに使用されます。

ログイン操作では、このプロパティの値が、ユーザーが所属するユーザーグループのuserdirectoryidプロパティより優先されます。

デフォルト: 0。

プロパティの動作:
- 読み取り専用
- Super adminタイプのユーザーでサポート
timezone string ユーザーのタイムゾーン（例: Europe/London、UTC）。

デフォルト: default - システムのデフォルト。

サポートされているタイムゾーンの完全な一覧については、PHPのドキュメントを参照してください。

メディア

メディアオブジェクトには以下のプロパティがあります。

プロパティ 型 説明
mediaid ID ユーザーのメディアのID。

プロパティの動作:
- 読み取り専用
mediatypeid ID ユーザーのメディアで使用されるメディアタイプのID。

プロパティの動作:
- 必須
sendto string/array 受信者のアドレス、ユーザー名、またはその他の識別子。

メディアタイプのtypeが「Email」に設定されている場合、値は配列で表されます。他のメディアタイプの場合、値は文字列で表されます。

プロパティの動作:
- 必須
active integer メディアが有効かどうか。

可能な値:
0 - (デフォルト) 有効;
1 - 無効。
severity integer 通知を送信するトリガーの深刻度。

可能なビットマップ値:
1 - 未分類;
2 - 情報;
4 - 警告;
8 - 軽度;
16 - 高度;
32 - 障害。

これはビットマスクフィールドであり、可能なビットマップ値の任意の合計が許容されます（例: 48は軽度、高度、障害）。

デフォルト: 63。
period string 通知を送信できる時間を時間帯またはユーザーマクロでセミコロン区切りで指定。

デフォルト: 1-7,00:00-24:00。
provisioned integer ユーザーがプロビジョニングされているかどうか。

可能な値:
0 - プロビジョニングされていない;
1 - プロビジョニングされている。
userdirectory_mediaid ID プロビジョニングされたメディアのユーザーディレクトリメディアマッピングID。

プロパティの動作:
- 読み取り専用
- スーパ管理者タイプのユーザーでサポート