Userオブジェクト

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

ユーザー

ユーザーオブジェクトは以下のプロパティを持ちます。

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

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

プロパティの動作:
- 作成操作では 必須
- ユーザーが ユーザーディレクトリ にリンクされており（userdirectoryid が "0" ではない有効な値に設定されている）、ユーザーディレクトリのプロビジョニングステータスが有効であり（User directory object の provision_status が "1" に設定されている）、かつすべてのLDAPまたはSAMLプロビジョニングの認証ステータスが有効である場合（Authentication object の ldap_jit_status が "Enabled for configured LDAP IdPs" に設定されている、または Authentication object の saml_jit_status が "Enabled for configured SAML IdPs" に設定されている）、プロビジョニングされたユーザー では 読み取り専用
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 ユーザーセッションの有効期間。秒、または接尾辞付きの時間単位を受け付けます。0s に設定すると、セッションは期限切れになりません。

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

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

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

プロパティの動作:
- 読み取り専用
refresh string 自動更新間隔。秒、または接尾辞付きの時間単位（例: 30s、90s、1m、1h）を受け付けます。

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

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

指定可能な値:
default - (デフォルト) システムデフォルト;
blue-theme - Blue;
blue-classic-theme - Blue (classic);
dark-theme - Dark;
dark-classic-theme - Dark (classic);
hc-light - High-contrast light;
hc-dark - High-contrast dark.
ts_provisioned timestamp 最新のプロビジョニング操作が実行された時刻。

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

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

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

デフォルト: 0。

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

デフォルト: 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。

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