[comment]: # aside: 1

[comment]: # ({c9088bab-f9e8f670})
# User directoryオブジェクト

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

[comment]: # ({/c9088bab-f9e8f670})

[comment]: # ({57811c28-ad144502})
### ユーザーディレクトリ

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|userdirectoryid|ID|ユーザーディレクトリのID。<br><br>ユーザーディレクトリが削除されると、削除されたユーザーディレクトリに関連付けられているすべてのユーザーについて、[User object](/manual/api/reference/user/object#user) のプロパティ `userdirectoryid` の値は "0" に設定されます。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *read-only*<br>- 更新操作では *required*|
|idp_type|integer|ユーザーディレクトリに対してIDプロバイダーが使用する認証プロトコルの種類。<br>SAMLタイプのユーザーディレクトリは1つだけ存在できます。<br><br>指定可能な値:<br>1 - LDAPタイプのユーザーディレクトリ;<br>2 - SAMLタイプのユーザーディレクトリ。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- 作成操作では *required*|
|group_name|string|LDAP/SAML ユーザーディレクトリ属性。LDAP/SAML ユーザーディレクトリとZabbixの間でグループをマッピングするために使用されるグループ名を含みます。<br><br>例: *cn*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `provision_status` が "Enabled" に設定され、かつ [Authentication object](/manual/api/reference/authentication/object#authentication) の `saml_jit_status` が "Enabled for configured SAML IdPs" に設定されている場合は *required*|
|user_username|string|LDAP/SAML ユーザーディレクトリ属性（`scim_status` が "SCIM provisioning is enabled" に設定されている場合は SCIM 属性でもあります）。ユーザーの名前を含み、ユーザーがプロビジョニングされる際に [User object](/manual/api/reference/user/object#user) のプロパティ `name` の値として使用されます。<br><br>例: *cn*, *commonName*, *displayName*, *name*|
|user_lastname|string|LDAP/SAML ユーザーディレクトリ属性（`scim_status` が "SCIM provisioning is enabled" に設定されている場合は SCIM 属性でもあります）。ユーザーの姓を含み、ユーザーがプロビジョニングされる際に [User object](/manual/api/reference/user/object#user) のプロパティ `surname` の値として使用されます。<br><br>例: *sn*, *surname*, *lastName*|
|provision_status|integer|ユーザーディレクトリのプロビジョニング状態。<br><br>指定可能な値:<br>0 - *(default)* Disabled（このユーザーディレクトリによって作成されるユーザーのプロビジョニングは無効）;<br>1 - Enabled（このユーザーディレクトリによって作成されるユーザーのプロビジョニングは有効。さらに、LDAP または SAML のプロビジョニング状態（[Authentication object](/manual/api/reference/authentication/object#authentication) の `ldap_jit_status` または `saml_jit_status`）も有効である必要があります）。|
|provision_groups|array|LDAP/SAML ユーザーグループパターンをZabbixのユーザーグループおよびユーザーロールにマッピングするための、[provisioning groups mappings](object#provisioning-groups-mappings) オブジェクトの配列。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `provision_status` が "Enabled" に設定されている場合は *required*|
|provision_media|array|ユーザーの LDAP/SAML メディア属性（例: email）を、通知送信用のZabbixユーザーメディアにマッピングするための [media type mappings](object#media-type-mappings) オブジェクトの配列。|
|**[LDAP](/manual/web_interface/frontend_sections/users/authentication/ldap)-specific properties:**|<|<|
|name|string|ユーザーディレクトリの一意な名前。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *required*|
|host|string|LDAPサーバーのホスト名、IP、またはURI。<br>URI にはスキーマ（`ldap://` または `ldaps://`）、ホスト、およびポート（任意）を含める必要があります。<br><br>例:<br>*host.example.com*<br>*127.0.0.1*<br>*ldap://ldap.example.com:389*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *required*|
|port|integer|LDAPサーバーのポート。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *required*|
|base_dn|string|LDAP ユーザーディレクトリにおけるユーザーアカウントへのベースパス。<br><br>例:<br>*ou=Users,dc=example,dc=org*<br>*ou=Users,ou=system*（OpenLDAP の場合）<br>*DC=company,DC=com*（Microsoft Active Directory の場合）<br>*uid=%{user},dc=example,dc=com*（ユーザーへの直接バインドの場合。プレースホルダー "*%{user}*" は必須）<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *required*|
|search_attribute|string|ログイン要求で提供された情報からユーザーアカウントを識別するために使用する LDAP ユーザーディレクトリ属性。<br><br>例:<br>*uid*（OpenLDAP の場合）<br>*sAMAccountName*（Microsoft Active Directory の場合）<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *required*|
|bind_dn|string|LDAPサーバーに対してバインドおよび検索を行うための LDAP サーバーアカウント。<br><br>ユーザーへの直接バインドおよび匿名バインドでは、`bind_dn` は空である必要があります。<br><br>例:<br>*uid=ldap_search,ou=system*（OpenLDAP の場合）<br>*CN=ldap_search,OU=user_group,DC=company,DC=com*（Microsoft Active Directory の場合）<br>*CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|bind_password|string|LDAPサーバーに対してバインドおよび検索を行うアカウントの LDAP パスワード。<br><br>ユーザーへの直接バインドおよび匿名バインドでは、`bind_password` は空である必要があります。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|description|string|ユーザーディレクトリの説明。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|group_basedn|string|LDAP ユーザーディレクトリにおけるグループへのベースパス。LDAP ユーザーディレクトリでユーザーメンバーシップチェックを設定するために使用されます。<br><br>`group_membership` が設定されている場合、ユーザーのプロビジョニング時には無視されます。<br><br>例: *ou=Groups,dc=example,dc=com*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|group_filter|string|ユーザーがメンバーである LDAP ユーザーディレクトリのグループを取得するためのフィルター文字列。LDAP ユーザーディレクトリでユーザーメンバーシップチェックを設定するために使用されます。<br><br>`group_membership` が設定されている場合、ユーザーのプロビジョニング時には無視されます。<br><br>サポートされる `group_filter` プレースホルダー:<br>*%{attr}* - 検索属性（`search_attribute` プロパティの値に置き換えられます）;<br>*%{groupattr}* - グループ属性（`group_member` プロパティの値に置き換えられます）;<br>*%{host}* - LDAPサーバーのホスト名、IP、またはURI（`host` プロパティの値に置き換えられます）;<br>*%{user}* - Zabbix ユーザー名。<br><br>デフォルト: *(%{groupattr}=%{user})*<br><br>例:<br>- *(member=uid=%{ref},ou=Users,dc=example,dc=com)* は、LDAP グループオブジェクトに "*member*" 属性があり、その値が "*uid=User1,ou=Users,dc=example,dc=com*" の場合に "User1" と一致し、"User1" がメンバーであるグループを返します;<br>- *(%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com)* は、LDAP グループオブジェクトに `group_member` プロパティで指定された属性があり、その値が "*cn=User1,ou=Users,ou=Zabbix,DC=example,DC=com*" の場合に "User1" と一致し、"User1" がメンバーであるグループを返します。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|group_member|string|グループメンバーに関する情報を含む LDAP ユーザーディレクトリ属性。LDAP ユーザーディレクトリでユーザーメンバーシップチェックを設定するために使用されます。<br><br>`group_membership` が設定されている場合、ユーザーのプロビジョニング時には無視されます。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|group_membership|string|ユーザーが所属するグループに関する情報を含む LDAP ユーザーディレクトリ属性。<br><br>例: *memberOf*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|search_filter|string|ログイン要求で提供された情報に基づいて、LDAP ユーザーディレクトリ内でユーザーを検索および認証するために使用するカスタムフィルター文字列。<br><br>サポートされる `search_filter` プレースホルダー:<br>*%{attr}* - 検索属性名（例: *uid*, *sAMAccountName*）;<br>*%{user}* - Zabbix ユーザー名。<br><br>デフォルト: *(%{attr}=%{user})*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|start_tls|integer|LDAPサーバーとの通信を Transport Layer Security (TLS) を使用して保護できるようにする LDAP サーバー設定オプション。<br><br>`ldaps://` プロトコルを使用するホストでは、`start_tls` を "Disabled" に設定する必要があることに注意してください。<br><br>指定可能な値:<br>0 - *(default)* Disabled;<br>1 - Enabled。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|user_ref_attr|string|ユーザーオブジェクトを参照するために使用される LDAP ユーザーディレクトリ属性。`user_ref_attr` の値は、ユーザーディレクトリ内の指定された属性から値を取得し、それを `group_filter` 文字列内の *%{ref}* プレースホルダーの代わりに配置するために使用されます。<br><br>例: *cn*, *uid*, *member*, *uniqueMember*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type LDAP" に設定されている場合は *supported*|
|**[SAML](/manual/web_interface/frontend_sections/users/authentication/saml)-specific properties:**|<|<|
|idp_entityid|string|IDプロバイダーを識別する URI。SAML メッセージで IDプロバイダーと通信するために使用されます。<br><br>例: *https://idp.example.com/idp*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *required*|
|sp_entityid|string|IDプロバイダーのサービスプロバイダーを識別する URL または任意の文字列。<br><br>例:<br>*https://idp.example.com/sp*<br>*zabbix*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *required*|
|username_attribute|string|SAML ユーザーディレクトリ属性（`scim_status` が "SCIM provisioning is enabled" に設定されている場合は SCIM 属性でもあります）。認証時に [User object](/manual/api/reference/user/object#user) のプロパティ `username` の値と比較されるユーザー名を含みます。<br><br>例: *uid*, *userprincipalname*, *samaccountname*, *username*, *userusername*, *urn:oid:0.9.2342.19200300.100.1.1*, *urn:oid:1.3.6.1.4.1.5923.1.1.1.13*, *urn:oid:0.9.2342.19200300.100.1.44*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *required*|
|sso_url|string|IDプロバイダーの SAML シングルサインオンサービスの URL。Zabbix はこの URL に SAML 認証要求を送信します。<br><br>例: *http://idp.example.com/idp/sso/saml*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *required*|
|slo_url|string|IDプロバイダーの SAML シングルログアウトサービスの URL。Zabbix はこの URL に SAML ログアウト要求を送信します。<br><br>例: *https://idp.example.com/idp/slo/saml*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|encrypt_nameid|integer|SAML name ID を暗号化するかどうか。<br><br>指定可能な値:<br>0 - *(default)* name ID を暗号化しない;<br>1 - name ID を暗号化する。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|encrypt_assertions|integer|SAML アサーションを暗号化するかどうか。<br><br>指定可能な値:<br>0 - *(default)* アサーションを暗号化しない;<br>1 - アサーションを暗号化する。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|nameid_format|string|SAML IDプロバイダーのサービスプロバイダーの Name ID 形式。<br><br>例:<br>*urn:oasis:names:tc:SAML:2.0:nameid-format:persistent*<br>*urn:oasis:names:tc:SAML:2.0:nameid-format:transient*<br>*urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos*<br>*urn:oasis:names:tc:SAML:2.0:nameid-format:entity*<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|scim_status|integer|SAML の SCIM プロビジョニングが有効か無効か。<br><br>指定可能な値:<br>0 - *(default)* SCIM プロビジョニングは無効;<br>1 - SCIM プロビジョニングは有効。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|sign_assertions|integer|SAML アサーションに SAML 署名を付与するかどうか。<br><br>指定可能な値:<br>0 - *(default)* アサーションに署名しない;<br>1 - アサーションに署名する。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|sign_authn_requests|integer|SAML AuthN 要求に SAML 署名を付与するかどうか。<br><br>指定可能な値:<br>0 - *(default)* AuthN 要求に署名しない;<br>1 - AuthN 要求に署名する。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|sign_messages|integer|SAML メッセージに SAML 署名を付与するかどうか。<br><br>指定可能な値:<br>0 - *(default)* メッセージに署名しない;<br>1 - メッセージに署名する。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|sign_logout_requests|integer|SAML ログアウト要求に SAML 署名を付与するかどうか。<br><br>指定可能な値:<br>0 - *(default)* ログアウト要求に署名しない;<br>1 - ログアウト要求に署名する。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|
|sign_logout_responses|integer|SAML ログアウト応答に SAML 署名を付与するかどうか。<br><br>指定可能な値:<br>0 - *(default)* ログアウト応答に署名しない;<br>1 - ログアウト応答に署名する。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- `idp_type` が "User directory of type SAML" に設定されている場合は *supported*|

[comment]: # ({/57811c28-ad144502})

[comment]: # ({07d3d820-c2b51996})
#### メディアタイプのマッピング

メディアタイプのマッピングオブジェクトには、以下のプロパティがあります。

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|----------------|
|userdirectory_mediaid|ID|メディアタイプマッピングID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|
|name|string|メディアタイプマッピングの一覧に表示される名前。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|mediatypeid|ID|作成されるメディアタイプのID。[メディアオブジェクト](/manual/api/reference/user/object#media) のプロパティ `mediatypeid` の値として使用されます。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|attribute|string|ユーザーのメディア（例: *user@example.com*）を含むLDAP/SAMLユーザーディレクトリ属性（`scim_status` が「SCIMプロビジョニングが有効」に設定されている場合はSCIM属性でもあります）。この値は、[メディアオブジェクト](/manual/api/reference/user/object#media) のプロパティ `sendto` の値として使用されます。<br><br>LDAP/SAMLアイデンティティプロバイダーから受信したデータ内にこの属性が存在し、かつ値が空でない場合、プロビジョニングされたユーザーのメディア作成がトリガーされます。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|active|integer|プロビジョニングされたユーザーに対してメディアが作成される際の、ユーザーメディア `active` プロパティの値。<br><br>指定可能な値:<br>0 - *(デフォルト)* 有効;<br>1 - 無効。|
|severity|integer|プロビジョニングされたユーザーに対してメディアが作成される際の、ユーザーメディア `severity` プロパティの値。<br><br>デフォルト: 63。|
|period|string|プロビジョニングされたユーザーに対してメディアが作成される際の、ユーザーメディア `period` プロパティの値。<br><br>デフォルト: 1-7,00:00-24:00。|

[comment]: # ({/07d3d820-c2b51996})

[comment]: # ({fe544518-67bd0ce1})
#### プロビジョニンググループマッピング

プロビジョニンググループマッピングには、以下のプロパティがあります。

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|----------------|
|name|string|LDAP/SAMLユーザーディレクトリ内のグループのフルネーム（例: *Zabbix administrators*）です（`scim_status` が「SCIM provisioning is enabled」に設定されている場合は SCIM も含みます）。<br>ワイルドカード文字「\*」をサポートします。<br>すべてのプロビジョニンググループマッピング内で一意である必要があります。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|roleid|ID|ユーザーに割り当てるユーザーロールのIDです。<br><br>複数のプロビジョニンググループマッピングが一致した場合、最も高いユーザータイプ（*User*、*Admin*、または *Super admin*）のロールがユーザーに割り当てられます。同じユーザータイプのロールが複数ある場合は、最初のロール（アルファベット順でソート）がユーザーに割り当てられます。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|user_groups|array|ZabbixユーザーグループIDオブジェクトの配列です。各オブジェクトには以下のプロパティがあります。<br>`usrgrpid` - `(ID)` ユーザーに割り当てるZabbixユーザーグループのID。<br><br>複数のプロビジョニンググループマッピングが一致した場合、一致したすべてのマッピングのZabbixユーザーグループがユーザーに割り当てられます。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|

[comment]: # ({/fe544518-67bd0ce1})