[comment]: # aside: 1

[comment]: # ({8f026b4a-0834cf88})
# Userオブジェクト

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

[comment]: # ({/8f026b4a-0834cf88})

[comment]: # ({730822db-0ecc45be})
### ユーザー

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|userid|ID|ユーザーのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*<br>- 更新操作では *必須*|
|username|string|ユーザー名。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- 作成操作では *必須*<br>- ユーザーが [ユーザーディレクトリ](/manual/api/reference/userdirectory/object) にリンクされており（`userdirectoryid` が "0" ではない有効な値に設定されている）、かつユーザーディレクトリのプロビジョニングステータスが有効であり（[User directory object](/manual/api/reference/userdirectory/object#userdirectory) の `provision_status` が "1" に設定されている）、さらにすべてのLDAPまたはSAMLプロビジョニングの認証ステータスが有効である場合（[Authentication object](/manual/api/reference/authentication/object#authentication) の `ldap_jit_status` が "Enabled for configured LDAP IdPs" に設定されている、または [Authentication object](/manual/api/reference/authentication/object#authentication) の `saml_jit_status` が "Enabled for configured SAML IdPs" に設定されている）、[プロビジョニングされたユーザー](/manual/web_interface/frontend_sections/users/authentication#default-authentication) では *読み取り専用*|
|passwd|string|ユーザーのパスワード。<br><br>ユーザーが [ユーザーディレクトリ](/manual/api/reference/userdirectory/object) にリンクされている場合、このパラメータの値は空文字列にできます。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *書き込み専用*|
|roleid|ID|ユーザーのロールのID。<br><br>ロールを持たないユーザーは、そのLDAP/SAML情報がZabbixで設定されたユーザーグループマッピングと一致する場合に限り、[LDAP](/manual/web_interface/frontend_sections/users/authentication/ldap) または [SAML](/manual/web_interface/frontend_sections/users/authentication/saml) 認証を使用してのみZabbixにログインできることに注意してください。|
|attempt\_clock|timestamp|最後にログインに失敗した試行の時刻。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|
|attempt\_failed|integer|直近のログイン失敗回数。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|
|attempt\_ip|string|最後にログインに失敗した試行元のIPアドレス。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|
|autologin|integer|自動ログインを有効にするかどうか。<br><br>指定可能な値:<br>0 - *(デフォルト)* 自動ログイン無効;<br>1 - 自動ログイン有効。|
|autologout|string|ユーザーセッションの有効期間。秒、または接尾辞付きの時間単位を受け付けます。0s に設定すると、セッションは期限切れになりません。<br><br>デフォルト: 15m。|
|lang|string|ユーザーの言語の言語コード。例: `en_US`。<br><br>デフォルト: `default` - システムデフォルト。|
|name|string|ユーザーの名。|
|provisioned|integer|ユーザーが[プロビジョニング](/manual/api/reference/user/provision)されているかどうか。<br><br>指定可能な値:<br>0 - プロビジョニングされていない;<br>1 - プロビジョニング済み。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|
|refresh|string|自動更新間隔。秒、または接尾辞付きの時間単位（例: 30s、90s、1m、1h）を受け付けます。<br><br>デフォルト: 30s。|
|rows\_per\_page|integer|1ページあたりに表示するオブジェクト行数。<br><br>デフォルト: 50。|
|surname|string|ユーザーの姓。|
|theme|string|ユーザーのテーマ。<br><br>指定可能な値:<br>`default` - *(デフォルト)* システムデフォルト;<br>`blue-theme` - Blue;<br>`dark-theme` - Dark;<br>`hc-light` - ハイコントラストライト;<br>`hc-dark` - ハイコントラストダーク。|
|ts_provisioned|timestamp|最新の[プロビジョニング](/manual/api/reference/user/provision)操作が実行された時刻。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*<br>- *Super admin* タイプのユーザーで *サポート*|
|url|string|ログイン後にユーザーをリダイレクトするページのURL。|
|userdirectoryid|ID|ユーザーがリンクされている [ユーザーディレクトリ](/manual/api/reference/userdirectory/object) のID。<br><br>プロビジョニング（作成または更新）およびユーザーディレクトリにリンクされたユーザーのログインに使用されます。<br><br>ログイン操作では、このプロパティの値は、ユーザーが所属する [ユーザーグループ](/manual/api/reference/usergroup/object#user-group) の `userdirectoryid` プロパティよりも優先されます。<br><br>デフォルト: 0。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*<br>- *Super admin* タイプのユーザーで *サポート*|
|timezone|string|ユーザーのタイムゾーン。例: `Europe/London`、`UTC`。<br><br>デフォルト: `default` - システムデフォルト。<br><br>サポートされているタイムゾーンの完全な一覧については、[PHP documentation](https://www.php.net/manual/en/timezones.php) を参照してください。|

[comment]: # ({/730822db-0ecc45be})

[comment]: # ({e65af01e-1ad487be})
### メディア

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

|Property|Type|Description|
|--|--|------|
|mediaid|ID|ユーザーのメディアのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|
|mediatypeid|ID|ユーザーのメディアで使用されるメディアタイプのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|sendto|string/array|受信者のアドレス、ユーザー名、またはその他の識別子。<br><br>[メディアタイプ](/manual/api/reference/mediatype/object#mediatype) の `type` が "Email" に設定されている場合、値は配列として表されます。[メディアタイプ](/manual/api/reference/mediatype/object#mediatype) のその他のタイプでは、値は文字列として表されます。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|active|integer|メディアが有効かどうか。<br><br>指定可能な値:<br>0 - *(デフォルト)* 有効;<br>1 - 無効。|
|severity|integer|通知を送信するトリガーの深刻度。<br><br>指定可能なビットマップ値:<br>1 - 未分類;<br>2 - 情報;<br>4 - 警告;<br>8 - 平均;<br>16 - 高;<br>32 - 障害。<br><br>これはビットマスクフィールドです。指定可能なビットマップ値の任意の合計を指定できます（たとえば、平均、高、障害の場合は 48）。<br><br>デフォルト: 63。|
|period|string|通知を送信できる時間。[time period](/manual/appendix/time_period) またはセミコロンで区切られたユーザーマクロで指定します。<br><br>デフォルト: 1-7,00:00-24:00。|
|provisioned|integer|ユーザーが[プロビジョニング](/manual/api/reference/user/provision)されているかどうか。<br><br>指定可能な値:<br>0 - プロビジョニングされていない;<br>1 - プロビジョニング済み。|
|userdirectory_mediaid|ID|プロビジョニングされたメディアのユーザーディレクトリメディアマッピングID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*<br>- *Super admin* タイプのユーザーで *サポート*|

[comment]: # ({/e65af01e-1ad487be})