Userオブジェクト

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

ユーザー

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

Property Type Description
userid ID ユーザーのID。

Property behavior:
- read-only
- 更新操作では required
username string ユーザー名。

Property behavior:
- 作成操作では required
- ユーザーがuser directoryにリンクされているprovisioned usersの場合は read-only (userdirectoryid が "0" ではない有効な値に設定されており、user directory provisioning status が有効 (provision_status of User directory object が "1" に設定されている)、かつ LDAP または SAML provisioning の認証ステータスがすべて有効 (ldap_jit_status of Authentication object が "Enabled for configured LDAP IdPs" に設定されている、または saml_jit_status of Authentication object が "Enabled for configured SAML IdPs" に設定されている)
passwd string ユーザーのパスワード。

ユーザーがuser directoryにリンクされている場合、このパラメータの値は空文字列にできます。

Property behavior:
- write-only
roleid ID ユーザーのロールのID。

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

Property behavior:
- read-only
attempt_failed integer 最近のログイン失敗回数。

Property behavior:
- read-only
attempt_ip string 最後に失敗したログイン試行が行われたIPアドレス。

Property behavior:
- read-only
autologin integer 自動ログインを有効にするかどうか。

取りうる値:
0 - (default) 自動ログイン無効;
1 - 自動ログイン有効。
autologout string ユーザーセッションの有効期間。秒数、または接尾辞付きの時間単位を指定できます。0s に設定すると、セッションは期限切れになりません。

Default: 15m.
lang string ユーザーの言語コード。たとえば en_US。

Default: default - システムのデフォルト。
name string ユーザーの名前。
provisioned integer ユーザーがprovisionedされているかどうか。

取りうる値:
0 - provisioned されていない;
1 - provisioned されている。

Property behavior:
- read-only
refresh string 自動更新間隔。秒数、または接尾辞付きの時間単位を指定できます（例: 30s, 90s, 1m, 1h）。

Default: 30s.
rows_per_page integer 1ページに表示するオブジェクト行数。

Default: 50.
surname string ユーザーの姓。
theme string ユーザーのテーマ。

取りうる値:
default - (default) システムのデフォルト;
blue-theme - Blue;
dark-theme - Dark;
hc-light - High-contrast light;
hc-dark - High-contrast dark.
ts_provisioned timestamp 最新のprovisioning操作が実行された時刻。

Property behavior:
- read-only
- Super admin タイプのユーザーで supported
url string ログイン後にユーザーをリダイレクトするページのURL。
userdirectoryid ID ユーザーがリンクされているuser directoryのID。

provisioning（作成または更新）に使用されるほか、user directory にリンクされたユーザーのログインにも使用されます。

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

Default: 0.

Property behavior:
- read-only
- Super admin タイプのユーザーで supported
timezone string ユーザーのタイムゾーン。たとえば Europe/London, UTC。

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

対応するタイムゾーンの一覧はPHP documentationを参照してください。

メディア

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

プロパティ 型 説明
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。

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