Table of Contents
User directoryオブジェクト
次のオブジェクトは、userdirectoryAPIに直接関連しています。
ユーザーディレクトリ
ユーザーディレクトリオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| userdirectoryid | ID | ユーザーディレクトリのID。 ユーザーディレクトリが削除された場合、削除されたユーザーディレクトリにリンクされているすべてのユーザーのユーザーオブジェクトプロパティ userdirectoryidの値は「0」に設定されます。プロパティの動作: - 読み取り専用 - 更新操作時に必須 |
| idp_type | integer | ユーザーディレクトリのアイデンティティプロバイダーで使用される認証プロトコルのタイプ。 タイプSAMLのユーザーディレクトリは1つしか存在できないことに注意してください。 可能な値: 1 - LDAPタイプのユーザーディレクトリ; 2 - SAMLタイプのユーザーディレクトリ。 プロパティの動作: - 作成操作時に必須 |
| group_name | string | LDAP/SAMLユーザーディレクトリ属性で、LDAP/SAMLユーザーディレクトリとZabbix間でグループをマッピングするために使用されるグループ名を含みます。 例: cn プロパティの動作: - provision_statusが「有効」に設定され、認証オブジェクトのsaml_jit_statusが「構成済みSAML IdPで有効」に設定されている場合に必須 |
| user_username | string | ユーザーのプロビジョニング時にユーザーオブジェクトプロパティnameの値として使用されるユーザー名を含むLDAP/SAMLユーザーディレクトリ属性（scim_statusが「SCIMプロビジョニングが有効」に設定されている場合はSCIM属性も含む）。例: cn, commonName, displayName, name |
| user_lastname | string | ユーザーのプロビジョニング時にユーザーオブジェクトプロパティsurnameの値として使用されるユーザーの姓を含むLDAP/SAMLユーザーディレクトリ属性（scim_statusが「SCIMプロビジョニングが有効」に設定されている場合はSCIM属性も含む）。例: sn, surname, lastName |
| provision_status | integer | ユーザーディレクトリのプロビジョニングステータス。 可能な値: 0 - (デフォルト) 無効（このユーザーディレクトリで作成されたユーザーのプロビジョニングは無効）; 1 - 有効（このユーザーディレクトリで作成されたユーザーのプロビジョニングは有効。また、LDAPまたはSAMLプロビジョニング（認証オブジェクトの 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サーバーとの通信をトランスポートレイヤーセキュリティ（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 | 認証時にユーザーオブジェクトプロパティ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 | ZabbixがSAML認証リクエストを送信するアイデンティティプロバイダーのSAMLシングルサインオンサービスのURL。 例: http://idp.example.com/idp/sso/saml プロパティの動作: - idp_typeが「SAMLタイプのユーザーディレクトリ」に設定されている場合に必須 |
| slo_url | string | ZabbixがSAMLログアウトリクエストを送信するアイデンティティプロバイダーのSAMLシングルログアウトサービスのURL。 例: 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タイプのユーザーディレクトリ」に設定され、zabbix.conf.phpで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート- 書き込み専用 |
| sp_private_key | string | SAMLシングルサインオン（SSO）サービスセットアップ用のサービスプロバイダー（SP）秘密鍵の内容。アイデンティティプロバイダー（IdP）との安全な認証およびデータ交換を提供します。 例: -----BEGIN CERTIFICATE----- MIIEvQIBADANBgkqhkiG9w0BA... ...more encoded data... -----END CERTIFICATE----- プロパティの動作: - idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、zabbix.conf.phpで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート- 書き込み専用 |
| sp_certificate | string | SAMLシングルサインオン（SSO）サービスセットアップ用のサービスプロバイダー（SP）証明書の内容。 例: -----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7... ...more encoded data... -----END CERTIFICATE----- プロパティの動作: - idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、zabbix.conf.phpで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート- 書き込み専用 |
| idp_certificate_hash | string | idp_certificate値のmd5ハッシュ。idp_certificateが空の場合は空文字列を返します。 プロパティの動作: - idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、zabbix.conf.phpで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート- 読み取り専用 |
| sp_private_key_hash | string | sp_private_key値のmd5ハッシュ。sp_private_keyが空の場合は空文字列を返します。 プロパティの動作: - idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、zabbix.conf.phpで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート- 読み取り専用 |
| sp_certificate_hash | string | sp_certificate値のmd5ハッシュ。sp_certificateが空の場合は空文字列を返します。 プロパティの動作: - idp_typeが「SAMLタイプのユーザーディレクトリ」に設定され、zabbix.conf.phpで$SSO['CERT_STORAGE']がdatabaseに設定されている場合にサポート- 読み取り専用 |
メディアタイプマッピング
メディアタイプマッピングオブジェクトには、以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| userdirectory_mediaid | ID | メディアタイプマッピングID プロパティの動作: - 読み取り専用 |
| name | 文字列 | メディアタイプマッピングのリストに表示される名前 プロパティの動作: - 必須 |
| mediatypeid | ID | 作成するメディアタイプのID メディア オブジェクト プロパティ mediatypeid の値として使用されます。プロパティの動作: - 必須 |
| attribute | string | LDAP/SAML ユーザーディレクトリ属性（scim_status が"SCIM プロビジョニングが有効"に設定されている場合は SCIM 属性）で、ユーザーのメディア（例：[email protected]）が含まれます。このメディアは、メディアオブジェクト プロパティ sendto の値として使用されます。LDAP/SAML アイデンティティプロバイダーから受信したデータに存在し、値が空でない場合、プロビジョニングされたユーザーのメディア作成がトリガーされます。 プロパティの動作: - 必須 |
| active | integer | プロビジョニングされたユーザーのメディアが作成されるときのユーザーメディアの active プロパティ値可能な値: 0 - (デフォルト) 有効; 1 - 無効 |
| severity | 整数 | プロビジョニングされたユーザーに対してメディアが作成される際のユーザーメディアのseverityプロパティ値デフォルト: 63 |
| period | 文字列 | プロビジョニングされたユーザーに対してメディアが作成される際のユーザーメディアのperiodプロパティ値デフォルト: 1～7、00:00～24:00 |
プロビジョニンググループのマッピング
プロビジョニンググループのマッピングには、以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name | string | LDAP/SAMLユーザーディレクトリ（scim_statusが"SCIMプロビジョニングが有効"に設定されている場合はSCIMも）内のグループのフルネーム（例：Zabbix administrators）ワイルドカード文字"*"をサポートします。 すべてのプロビジョニンググループのマッピングで一意です。 プロパティの動作: - 必須 |
| roleid | ID | ユーザーに割り当てるユーザーロールのID 複数のプロビジョニンググループマッピングが一致した場合、最も高いユーザータイプ（User、Admin、またはSuper admin）のロールがユーザーに割り当てられます。同じユーザータイプのロールが複数ある場合は、最初のロール（アルファベット順）がユーザーに割り当てられます。 プロパティの動作: - 必須 |
| user_groups | array | ZabbixユーザーグループIDオブジェクトの配列各オブジェクトには次のプロパティがあります:usrgrpid - (ID) ユーザーに割り当てる Zabbix ユーザー グループの ID複数のプロビジョニング グループ マッピングが一致する場合、一致したすべてのマッピングの Zabbix ユーザー グループがユーザーに割り当てられます。 プロパティの動作: - 必須 |