Table of Contents
Userオブジェクト
次のオブジェクトは、userAPIに直接関連しています。
ユーザー
ユーザーオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| userid | ID | ユーザーのID。 プロパティの動作: - 読み取り専用 - 更新操作時に必須 |
| username | string | ユーザー名。 プロパティの動作: - 作成操作時に必須 - ユーザーディレクトリにリンクされているプロビジョニングユーザーの場合、ユーザーディレクトリプロビジョニングステータスが有効（ユーザーディレクトリオブジェクトの provision_statusが"1"）、かつすべてのLDAPまたはSAMLプロビジョニングの認証ステータスが有効（認証オブジェクトのldap_jit_statusが"設定済みLDAP IdPで有効"またはsaml_jit_statusが"設定済みSAML IdPで有効"）で、userdirectoryidが"0"以外の有効な値に設定されている場合は読み取り専用 |
| passwd | string | ユーザーのパスワード。 このパラメータの値は、ユーザーディレクトリにリンクされている場合、空文字列にすることができます。 プロパティの動作: - 書き込み専用 |
| roleid | ID | ユーザーのロールID。 ロールのないユーザーは、Zabbixで設定されたユーザーグループマッピングと一致するLDAP/SAML情報がある場合にのみ、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 - ブルー;dark-theme - ダーク。 |
| ts_provisioned | timestamp | 最新のプロビジョニング操作が行われた時刻。 プロパティの動作: - 読み取り専用 - スーパ管理者タイプのユーザーでサポート |
| url | string | ログイン後にユーザーをリダイレクトするページのURL。 |
| userdirectoryid | ID | ユーザーがリンクされているユーザーディレクトリのID。 プロビジョニング（作成または更新）や、ユーザーディレクトリにリンクされたユーザーのログインに使用されます。 ログイン操作では、このプロパティの値が、ユーザーが所属するユーザーグループの userdirectoryidプロパティよりも優先されます。デフォルト: 0。 プロパティの動作: - 読み取り専用 - スーパ管理者タイプのユーザーでサポート |
| 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。 プロパティの動作: - 読み取り専用 - スーパ管理者タイプのユーザーでサポート |