User directoryオブジェクト

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

ユーザーディレクトリ

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

プロパティ タイプ 説明
userdirectoryid ID ユーザーディレクトリのID。

ユーザーディレクトリが削除されると、削除されたユーザーディレクトリにリンクされているすべてのユーザーについて、Userオブジェクトのuserdirectoryidプロパティの値が「0」に設定されます。

プロパティの動作:
- 読み取り専用
- 更新操作では必須
idp_type integer ユーザーディレクトリのアイデンティティプロバイダーで使用される認証プロトコルのタイプ。
タイプSAMLのユーザーディレクトリは1つだけ存在できます。

指定可能な値:
1 - LDAPタイプのユーザーディレクトリ;
2 - SAMLタイプのユーザーディレクトリ。

プロパティの動作:
- 作成操作では必須
group_name string LDAP/SAMLユーザーディレクトリとZabbix間でグループをマッピングするために使用するグループ名を含む、LDAP/SAMLユーザーディレクトリの属性。

例: cn

プロパティの動作:
- provision_statusが「有効」に設定され、Authenticationオブジェクトのsaml_jit_statusが「設定済みのSAML IdPで有効」に設定されている場合は必須
user_username string プロビジョニング時にUserオブジェクトのnameプロパティの値として使用されるユーザー名を含む、LDAP/SAMLユーザーディレクトリの属性（scim_statusが「SCIMプロビジョニングが有効」に設定されている場合はSCIM属性でもあります）。

例: cn、commonName、displayName、name
user_lastname string プロビジョニング時にUserオブジェクトのsurnameプロパティの値として使用されるユーザーの姓を含む、LDAP/SAMLユーザーディレクトリの属性（scim_statusが「SCIMプロビジョニングが有効」に設定されている場合はSCIM属性でもあります）。

例: sn、surname、lastName
provision_status integer ユーザーディレクトリのプロビジョニングステータス。

指定可能な値:
0 - (デフォルト) 無効（このユーザーディレクトリによって作成されたユーザーのプロビジョニングは無効）;
1 - 有効（このユーザーディレクトリによって作成されたユーザーのプロビジョニングは有効。さらに、LDAPまたはSAMLプロビジョニング（Authenticationオブジェクトのldap_jit_statusまたはsaml_jit_status）も有効にする必要があります）。
provision_groups array LDAP/SAMLユーザーグループのパターンをZabbixユーザーグループおよびユーザーロールにマッピングするためのプロビジョニンググループマッピングオブジェクトの配列。

プロパティの動作:
- provision_statusが「有効」に設定されている場合は必須
provision_media array ユーザーのLDAP/SAMLメディア属性（メールアドレスなど）を、通知の送信に使用するZabbixユーザーメディアにマッピングするためのメディアタイプマッピングオブジェクトの配列。
LDAP固有のプロパティ:
name string ユーザーディレクトリの一意の名前。

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合は必須
host string LDAPサーバーのホスト名、IPアドレス、またはURI。
URIにはスキーマ（ldap://またはldaps://）、ホスト、およびポート（任意）を含める必要があります。

例:
host.example.com
127.0.0.1
ldap://ldap.example.com:389

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合は必須
port integer LDAPサーバーのポート。

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合は必須
base_dn string ユーザーアカウントに対するLDAPユーザーディレクトリのベースパス。

例:
ou=Users,dc=example,dc=org
ou=Users,ou=system（OpenLDAPの場合）
DC=company,DC=com（Microsoft Active Directoryの場合）
uid=%{user},dc=example,dc=com（直接ユーザーバインディングの場合。プレースホルダー「%{user}」は必須）

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合は必須
search_attribute string ログイン要求で提供された情報からユーザーアカウントを識別するためのLDAPユーザーディレクトリ属性。

例:
uid（OpenLDAPの場合）
sAMAccountName（Microsoft Active Directoryの場合）

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合は必須
bind_dn string LDAPサーバーへのバインドおよび検索に使用するLDAPサーバーアカウント。

直接ユーザーバインディングおよび匿名バインディングの場合、bind_dnは空である必要があります。

例:
uid=ldap_search,ou=system（OpenLDAPの場合）
CN=ldap_search,OU=user_group,DC=company,DC=com（Microsoft Active Directoryの場合）
CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
bind_password string LDAPサーバーへのバインドおよび検索に使用するアカウントのLDAPパスワード。

直接ユーザーバインディングおよび匿名バインディングの場合、bind_passwordは空である必要があります。

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
description string ユーザーディレクトリの説明。

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
group_basedn string グループに対するLDAPユーザーディレクトリのベースパス。LDAPユーザーディレクトリでユーザーメンバーシップチェックを設定するために使用されます。

group_membershipが設定されている場合、ユーザーのプロビジョニング時には無視されます。

例: ou=Groups,dc=example,dc=com

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
group_filter string ユーザーが所属するLDAPユーザーディレクトリのグループを取得するためのフィルター文字列。LDAPユーザーディレクトリでユーザーメンバーシップチェックを設定するために使用されます。

group_membershipが設定されている場合、ユーザーのプロビジョニング時には無視されます。

サポートされるgroup_filterプレースホルダー:
%{attr} - 検索属性（search_attributeプロパティの値に置換）;
%{groupattr} - グループ属性（group_memberプロパティの値に置換）;
%{host} - LDAPサーバーのホスト名、IPアドレス、またはURI（hostプロパティの値に置換）;
%{user} - Zabbixユーザーのユーザー名。

デフォルト: (%{groupattr}=%{user})

例:
- (member=uid=%{ref},ou=Users,dc=example,dc=com)は、LDAPグループオブジェクトに値「uid=User1,ou=Users,dc=example,dc=com」の「member」属性が含まれている場合に「User1」と一致し、「User1」が所属するグループを返します;
- (%{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」が所属するグループを返します。

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
group_member string グループメンバーに関する情報を含むLDAPユーザーディレクトリの属性。LDAPユーザーディレクトリでユーザーメンバーシップチェックを設定するために使用されます。

group_membershipが設定されている場合、ユーザーのプロビジョニング時には無視されます。

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
group_membership string ユーザーが所属するグループに関する情報を含むLDAPユーザーディレクトリの属性。

例: memberOf

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
search_filter string ログイン要求で提供された情報に基づいて、LDAPユーザーディレクトリ内のユーザーを検索および認証するために使用するカスタムフィルター文字列。

サポートされるsearch_filterプレースホルダー:
%{attr} - 検索属性名（例: uid、sAMAccountName）;
%{user} - Zabbixユーザーのユーザー名。

デフォルト: (%{attr}=%{user})

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
start_tls integer LDAPサーバーとの通信をTransport Layer Security（TLS）で保護できるLDAPサーバー設定オプション。

ldaps://プロトコルを使用するホストでは、start_tlsを「無効」に設定する必要があります。

指定可能な値:
0 - (デフォルト) 無効;
1 - 有効。

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
user_ref_attr string ユーザーオブジェクトを参照するために使用するLDAPユーザーディレクトリの属性。user_ref_attrの値は、ユーザーディレクトリ内の指定された属性から値を取得し、group_filter文字列内の%{ref}プレースホルダーの代わりに挿入するために使用されます。

例: cn、uid、member、uniqueMember

プロパティの動作:
- idp_typeが「LDAPタイプのユーザーディレクトリ」に設定されている場合にサポート
SAML固有のプロパティ:
idp_entityid string アイデンティティプロバイダーを識別し、SAMLメッセージでアイデンティティプロバイダーとの通信に使用するURI。

例: https://idp.example.com/idp

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合は必須
sp_entityid string アイデンティティプロバイダーのサービスプロバイダーを識別するURLまたは任意の文字列。

例:
https://idp.example.com/sp
zabbix

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合は必須
username_attribute string 認証時にUserオブジェクトのusernameプロパティの値と比較されるユーザー名を含むSAMLユーザーディレクトリの属性（scim_statusが「SCIMプロビジョニングが有効」に設定されている場合はSCIM属性でもあります）。

例: 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

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合は必須
sso_url string アイデンティティプロバイダーのSAMLシングルサインオンサービスのURL。ZabbixはこのURLにSAML認証要求を送信します。

例: http://idp.example.com/idp/sso/saml

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合は必須
slo_url string アイデンティティプロバイダーのSAMLシングルログアウトサービスのURL。ZabbixはこのURLにSAMLログアウト要求を送信します。

例: https://idp.example.com/idp/slo/saml

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
encrypt_nameid integer SAML name IDを暗号化するかどうか。

指定可能な値:
0 - (デフォルト) name IDを暗号化しない;
1 - name IDを暗号化する。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
encrypt_assertions integer SAMLアサーションを暗号化するかどうか。

指定可能な値:
0 - (デフォルト) アサーションを暗号化しない;
1 - アサーションを暗号化する。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
nameid_format string SAMLアイデンティティプロバイダーのサービスプロバイダーのname ID形式。

例:
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
urn:oasis:names:tc:SAML:2.0:nameid-format:transient
urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos
urn:oasis:names:tc:SAML:2.0:nameid-format:entity

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
scim_status integer SAMLのSCIMプロビジョニングを有効にするか無効にするか。

指定可能な値:
0 - (デフォルト) SCIMプロビジョニングは無効;
1 - SCIMプロビジョニングは有効。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
sign_assertions integer SAMLアサーションにSAML署名を付与するかどうか。

指定可能な値:
0 - (デフォルト) アサーションに署名しない;
1 - アサーションに署名する。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
sign_authn_requests integer SAML AuthN要求にSAML署名を付与するかどうか。

指定可能な値:
0 - (デフォルト) AuthN要求に署名しない;
1 - AuthN要求に署名する。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
sign_messages integer SAMLメッセージにSAML署名を付与するかどうか。

指定可能な値:
0 - (デフォルト) メッセージに署名しない;
1 - メッセージに署名する。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
sign_logout_requests integer SAMLログアウト要求にSAML署名を付与するかどうか。

指定可能な値:
0 - (デフォルト) ログアウト要求に署名しない;
1 - ログアウト要求に署名する。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
sign_logout_responses integer SAMLログアウト応答にSAML署名を付与するかどうか。

指定可能な値:
0 - (デフォルト) ログアウト応答に署名しない;
1 - ログアウト応答に署名する。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合にサポート
idp_certificate string SAMLシングルサインオン（SSO）サービス設定用のサービスプロバイダー（SP）証明書の内容。

例:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、Webインターフェース設定ファイルで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート
- 書き込み専用
sp_private_key string SAMLシングルサインオン（SSO）サービス設定用のサービスプロバイダー（SP）秘密鍵の内容。
アイデンティティプロバイダー（IdP）との安全な認証およびデータ交換を提供します。

例:
-----BEGIN CERTIFICATE-----
MIIEvQIBADANBgkqhkiG9w0BA...
...more encoded data...
-----END CERTIFICATE-----

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、Webインターフェース設定ファイルで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート
- 書き込み専用
sp_certificate string SAMLシングルサインオン（SSO）サービス設定用のサービスプロバイダー（SP）証明書の内容。

例:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、Webインターフェース設定ファイルで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート
- 書き込み専用
idp_certificate_hash string idp_certificate値のmd5ハッシュ。空のidp_certificateの場合は空の文字列を返します。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、Webインターフェース設定ファイルで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート
- 読み取り専用
sp_private_key_hash string sp_private_key値のmd5ハッシュ。空のsp_private_keyの場合は空の文字列を返します。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、Webインターフェース設定ファイルで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート
- 読み取り専用
sp_certificate_hash string sp_certificate値のmd5ハッシュ。空のsp_certificateの場合は空の文字列を返します。

プロパティの動作:
- idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、Webインターフェース設定ファイルで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート
- 読み取り専用

メディアタイプマッピング

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

プロパティ 型 説明
userdirectory_mediaid ID メディアタイプマッピングID。

プロパティの動作:
- 読み取り専用
name string メディアタイプマッピングの一覧に表示される名前。

プロパティの動作:
- 必須
mediatypeid ID 作成されるメディアタイプのID。メディアオブジェクト のプロパティ mediatypeid の値として使用されます。

プロパティの動作:
- 必須
attribute string ユーザーのメディア（例: [email protected]）を含むLDAP/SAMLユーザーディレクトリ属性（scim_status が「SCIMプロビジョニングが有効」に設定されている場合はSCIM属性でも可）。この値は、メディアオブジェクト のプロパティ sendto の値として使用されます。

LDAP/SAMLアイデンティティプロバイダーから受信したデータ内にこの属性が存在し、かつ値が空でない場合、プロビジョニングされたユーザーのメディア作成がトリガーされます。

プロパティの動作:
- 必須
active integer プロビジョニングされたユーザーに対してメディアが作成される際の、ユーザーメディア active プロパティの値。

指定可能な値:
0 - (デフォルト) 有効;
1 - 無効。
severity integer プロビジョニングされたユーザーに対してメディアが作成される際の、ユーザーメディア severity プロパティの値。

デフォルト: 63。
period string プロビジョニングされたユーザーに対してメディアが作成される際の、ユーザーメディア period プロパティの値。

デフォルト: 1-7,00:00-24:00。

プロビジョニンググループマッピング

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

プロパティ 型 説明
name string LDAP/SAMLユーザーディレクトリ内のグループのフルネーム（例: Zabbix administrators）です（scim_status が「SCIM provisioning is enabled」に設定されている場合は、SCIMも含みます）。
ワイルドカード文字「*」をサポートします。
すべてのプロビジョニンググループマッピング内で一意である必要があります。

プロパティの動作:
- 必須
roleid ID ユーザーに割り当てるユーザーロールのIDです。

複数のプロビジョニンググループマッピングが一致した場合、最も高いユーザータイプ（User、Admin、または Super admin）のロールがユーザーに割り当てられます。同じユーザータイプのロールが複数ある場合は、最初のロール（アルファベット順でソート）がユーザーに割り当てられます。

プロパティの動作:
- 必須
user_groups array ZabbixユーザーグループIDオブジェクトの配列です。各オブジェクトには以下のプロパティがあります。
usrgrpid - (ID) ユーザーに割り当てるZabbixユーザーグループのID。

複数のプロビジョニンググループマッピングが一致した場合、一致したすべてのマッピングのZabbixユーザーグループがユーザーに割り当てられます。

プロパティの動作:
- 必須