Documentation
Table of Contents
Userオブジェクト
次のオブジェクトは、userAPIに直接関連しています。
User
Userオブジェクトには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| userid | string | (読取専用)ユーザーID |
| username (必須) |
string | ユーザー名 |
| attempt_clock | timestamp | (読取専用)最後に失敗したログイン試行の時刻 |
| attempt_failed | integer | (読取専用)直近の失敗したログイン試行回数 |
| attempt_ip | string | (読取専用)最後に失敗したログイン試行の送信元IPアドレス |
| autologin | integer | 自動ログインを有効にするか 利用可能な値: 0 - (デフォルト)自動ログイン無効 1 - 自動ログイン有効 |
| autologout | string | ユーザーセッションの存続期間。 接尾辞付きの秒と時間の単位を受け入れます。 0に設定すると、セッションは無期限に。 デフォルト:15m。 |
| lang | string | ユーザーの言語コード。たとえばen_GB。デフォルト: default - システムデフォルト |
| name | string | ユーザー名 |
| refresh | string | 自動更新期間。 接尾辞付きの秒と時間の単位を受け入れます。 デフォルト:30秒。 |
| rows_per_page | integer | １ページに表示するオブジェクト行数 デフォルト:50 |
| surname | string | ユーザー名 |
| theme | string | ユーザーのテーマ 利用可能な値: default - (デフォルト)システムデフォルトblue-theme - 青dark-theme - 暗い |
| url | string | ログイン後にユーザーをリダイレクトするページのURL |
| timezone | string | ユーザーのタイムゾーン(例:Europe/London,UTC)デフォルト: default - システムデフォルトサポートされているタイムゾーンの完全なリストについては、PHPドキュメント参照 |
| roleid (必須) |
string | ユーザーロールID |
Media
The media オブジェクトには次のプロパティがあります
| プロパティ | タイプ | 説明 |
|---|---|---|
| mediatypeid (必須) |
string | メディアが使用するメディアタイプのID |
| sendto (必須) |
string/array | 受信者のアドレス、ユーザー名、またはその他の識別子 メディアタイプが電子メールの場合、値は配列として表されます。 他のタイプのメディアタイプの場合、値は文字列として表されます。 |
| active | integer | メディアの有効無効 利用可能な値: 0 - (デフォルト)有効 1 - 無効 |
| severity | integer | 深刻度をトリガーとして通知を送信します 深刻度はバイナリ形式で保存され、各ビットは対応する深刻度を表します。 たとえば12はバイナリで1100に等しく、深刻度でいう警告と平均を伴うトリガーから通知が送信されることを意味します。 サポートされているトリガーの深刻度リストはトリガーオブジェクトのページを参照してください。 デフォルト:63 |
| period | string | 通知を送信できる時間。期間またはセミコロンで区切ったユーザーマクロで指定 デフォルト: 1-7,00:00-24:00 |