Documentation
Table of Contents
Objecte directori d'usuaris
Els objectes següents són relacionats directament amb l'API userdirectory.
Directori d'usuari
El directori d'usuari té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| userdirectoryid | ID | ID del directori d'usuari. Si s'esborra un directori d'usuari, el valor de la propietat User object userdirectoryid s'estableix a "0" per a tots els usuaris que són enllaçats al directori d'usuaris esborrat.Comportament de la propietat: - només lectura - obligatori per a les operacions d'actualització |
| idp_type | integer | Tipus del protocol d'autenticació que empra el proveïdor d'identitats per al directori d'usuaris. Tingueu en compte que només pot existir un directori d'usuaris de tipus SAML. Valors possibles: 1 -Directori d'usuaris de tipus LDAP; 2 -Directori d'usuaris de tipus SAML. Comportament de la propietat: - obligatori per a operacions de creació |
| name_group | string | Atribut del directori d'usuaris LDAP/SAML que conté el nom del grup emprat per mapar grups entre el directori d'usuaris LDAP/SAML i Zabbix. Exemple: cn Comportament de la propietat: - obligatori si provision_status s'estableix a "Activat" i saml_jit_status d'Objecte d'autenticació s'estableix a "Habilitat per als IdP SAML configurats" |
| user_username | string | Atribut del directori d'usuari LDAP/SAML (també atribut SCIM si scim_status s'estableix a "El subministrament SCIM és habilitat") que conté el nom de l'usuari que s'empra com a valor per a l'objecte d'usuari propietat name quan s'aprovisiona l'usuari.Exemples: cn, commonName, displayName, name |
| user_lastname | string | Atribut del directori d'usuari LDAP/SAML (també atribut SCIM si scim_status és establert a "El subministrament SCIM és activat") que conté el cognom de l'usuari que s'empra com a valor per a l'objecte d'usuari propietat cognom quan s'aprovisiona l'usuari.Exemples: sn, surname, lastName |
| provision_status | integer | Estat d'aprovisionament del directori d'usuaris. Valors possibles: 0 - (per defecte) Inhabilitat (l'aprovisionament dels usuaris creats per aquest directori d'usuaris és desactivat); 1 - Activat (l'aprovisionament d'usuaris creats per aquest directori d'usuaris és habilitat; a més, l'estat de l'aprovisionament LDAP o SAML ( ldap_jit_status o saml_jit_status de l'Objecte d'autenticació)) s'ha d'habilitar). |
| provision_groups | array | Matriu d'objectes mapatges de grups d'aprovisionament per associar el patró de grup d'usuaris LDAP/SAML al grup d'usuaris i rol d'usuari Zabbix. Comportament de la propietat: - obligatori si provision_status és establert com a "Activat" |
| provision_media | array | Matriu de mapatges de tipus de suport objectes per assignar els atributs de mitjans LDAP/SAML de l'usuari (per exemple, correu electrònic) als mitjans d'usuari Zabbix per enviar notificacions. |
| Propietats específiques d'LDAP: | ||
| name | string | Nom únic del directori d'usuari. Comportament de la propietat: - obligatori si idp_type és establert a " Directori d'usuaris de tipus LDAP" |
| host | string | Nom d'equip, IP o URI del servidor LDAP. l'URI ha de contindre l'esquema ( ldap:// o ldaps://), l'equip i el port (opcional).Exemples: equip.exemple.com 127.0.0.1 ldap://ldap.example.com:389 Comportament de la propietat: - obligatori si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| port | integer | Port del servidor LDAP. Comportament de la propietat: - obligatori si idp_type és establert a "Usuari directori de tipus LDAP" |
| base_dn | string | Camí base del directori d'usuaris LDAP als comptes d'usuari. Exemples: ou=Usuaris,dc=exemple,dc=org ou=Usuaris,ou=sistema (per a OpenLDAP) DC=company,DC=com (per a Microsoft Active Directory) uid=%{user},dc=example,dc=com (per a l'enllaç directe d'usuari; marcador de posició "%{user}" és obligatori) Comportament de la propietat: - obligatori si idp_type s'estableix a "Directori d'usuari de escriviu LDAP" |
| search_attribute | string | Atribut del directori d'usuari LDAP pel qual s'identifica el compte d'usuari a partir de la informació proporcionada a la petició d'inici de sessió. Exemples: uid (per a OpenLDAP) sAMAccountName (per a Microsoft Active Directory) Comportament de la propietat: - obligatori si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| bind_dn | string | Compte de servidor LDAP per vincular i cercar al servidor LDAP. Per a l'enllaç directe d'usuari i l'enllaç anònim, bind_dn ha de ser buit.Exemples: uid=ldap_search,ou=system (per a OpenLDAP) CN=ldap_search,OU=grup_usuaris,DC=empresa,DC=com (per a Microsoft Active Directory) CN=Administrador,OU=Usuaris,OU=Zabbix,DC=zbx,DC=local Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuaris de tipus LDAP" |
| bind_password | string | mot de pas LDAP del compte per vincular i cercar al servidor LDAP. Per a l'enllaç directe d'usuari i l'enllaç anònim, bind_password ha de ser buit.Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuaris de tipus LDAP" |
| description | string | Descripció del directori d'usuaris. Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| group_basedn | string | Ruta base del directori d'usuaris LDAP als grups; s'empra per configurar una comprovació de pertinença d'usuari al directori d'usuaris LDAP. S'ignora quan s'aprovisiona un usuari si s'ha definit group_membership.Exemple: ou=Groups,dc=example,dc=com Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| group_filter | string | Cadena de filtre per recuperar grups de directoris d'usuaris LDAP dels quals l'usuari n'és membre; s'empra per configurar una comprovació de pertinença d'usuari al directori d'usuaris LDAP. S'ignora quan s'aprovisiona un usuari si s'ha definit group_membership.Reservadors de posició group_filter admesos:%{attr} - atribut de cerca (substituït pel valor de propietat search_attribute);%{groupattr} - atribut de grup (substituït pel valor de propietat group_member);%{host} - nom d'equip, IP o URI del servidor LDAP (substituït pel valor de la propietat host);%{user} - nom d'usuari de l'usuari Zabbix. Per defecte: (%{groupattr}=% {usuari}) Exemples: - (member=uid=%{ref},ou=Usuaris,dc=example,dc=com) coincidirà amb "Usuari1" si un grup LDAP conté l'atribut "member" amb el valor "uid=Usuari1,ou=Usuaris,dc=example,dc=com", i retornarà el grup del qual "Usuari1" n'és membre; - (%{groupattr}=cn=%{ref},ou=Usuaris,ou=Zabbix,DC=example,DC=com) coincidirà amb "Usuari1" si un objecte de grup LDAP conté l'atribut especificat a la propietat group_member amb el valor "cn=Usuari1,ou=Usuaris,ou=Zabbix,DC=example,DC=com", i retornarà el grup del qual "Usuari1" n'és membre.Comportament de la propietat: - admès si idp_type s'estableix a "Directori d'usuaris de tipus LDAP" |
| group_member | string | Atribut del directori d'usuaris LDAP que conté informació sobre els membres del grup; s'empra per configurar una comprovació de pertinença d'usuari al directori d'usuaris LDAP. S'ignora quan s'aprovisiona un usuari si s'ha definit group_membership.Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| group_membership | string | Atribut del directori d'usuaris LDAP que conté informació sobre els grups als quals pertany un usuari. Exemple: memberOf Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| search_filter | string | Cadena de filtre personalitzada que s'empra per trobar i autenticar un usuari en un directori d'usuaris LDAP en funció de la informació proporcionada a la petició d'inici de sessió. Reservadors de posició search_filter admesos:%{attr} - nom de l'atribut de cerca (p. ex., uid, sAMAccountName); %{user} - nom d'usuari de Zabbix. Per defecte: (%{attr}=%{user}) Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| start_tls | integer | Opció de configuració del servidor LDAP que permet assegurar la comunicació amb el servidor LDAP mitjançant Transport Layer Security (TLS). Tingueu en compte que start_tls s'ha d'establir com a "Desactivat" per als equips que empren el Protocol ldaps://.Valors possibles: 0 - (per defecte) Desactivat; 1 - Activat. Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus LDAP" |
| user_ref_attr | string | Atribut del directori d'usuari LDAP emprat per fer referència a un objecte d'usuari. El valor d'user_ref_attr s'empra per obtindre valors de l'atribut especificat al directori d'usuari i posar-los en lloc del marcador de posició %{ref} a la cadena group_filter.Exemples: cn , uid, member, uniqueMember Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuaris de tipus LDAP" |
| SAML-propietats específiques: | ||
| idp_entityid | string | URI que identifica el proveïdor d'identitat i s'empra per comunicar-se amb el proveïdor d'identitat als missatges SAML. Exemple: https://idp.example.com/idp Comportament de la propietat: - obligatori si idp_type és establert a "Directori d'usuari de tipus SAML" |
| sp_entityid | string | URL o qualsevol cadena que identifiqui el proveïdor de serveis del proveïdor d'identitat. Exemples: https://idp.example.com/sp zabbix Comportament de la propietat: - obligatori si idp_type és establert a "Directori d'usuari de tipus SAML" |
| username_attribute | string | SAML user directory attribute (també atribut SCIM si scim_status s'estableix a "provisionament SCIM activat") que conté el nom d'usuari de l'usuari que es compara amb el valor de la propietat username de l'Objecte usuari quan s'autentica.Exemples: uid, userprincipalname, samaccountname, username, username, 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 Comportament de propietat: - obligatori si idp_type és establert a "Directori d'usuari de tipus SAML" |
| sso_url | string | URL del servei d'inici de sessió únic SAML del proveïdor d'identitats, al qual Zabbix enviarà les peticions d'autenticació SAML. Exemple: http://idp.example.com/idp/sso/saml Comportament de la propietat: - obligatori si idp_type és establert a "Directori d'usuari de tipus SAML" |
| slo_url | string | URL del servei de tancament únic de SAML del proveïdor d'identitats, al qual Zabbix enviarà les peticions de tancament de SAML. Exemple: https://idp.example.com/idp/slo/saml Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus SAML" |
| encrypt_nameid | integer | Si l'ID de nom SAML s'ha de xifrar. Valors possibles: 0 -(per defecte) No encripteu l'ID de nom; 1 - Encripteu l'ID de nom.<br > Comportament de la propietat: - admès si idp_type s'estableix en "Directori d'usuari de tipus SAML" |
| encrypt_assertions | integer | Si les afirmacions SAML s'han de xifrar. Valors possibles: 0 - (per defecte) No encripteu les afirmacions; 1 - Encripteu les afirmacions. <br >Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuaris de tipus SAML" |
| nameid_format | string | Format d'identificador de nom del proveïdor de serveis del proveïdor d'identitat SAML. Exemples: 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 Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuaris de tipus SAML" |
| scim_status | integer | Si el subministrament SCIM per a SAML és activat o desactivat. Valors possibles: 0 - (per defecte) El subministrament SCIM és desactivat; 1 - El subministrament SCIM és habilitat. Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus SAML" |
| sign_assertions | integer | Si les afirmacions SAML s'han de signar amb una signatura SAML. Valors possibles: 0 - (per defecte) No signar assercions; 1 - Signar assercions.< br> Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus SAML" |
| sign_authn_requests | integer | Si les peticions d'autenticació SAML s'han de signar amb una signatura SAML. Valors possibles: 0 - (per defecte) No signar peticions d'autenticació; 1 - Signa peticions d'autenticació. Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus SAML" |
| sign_messages | integer | Si els missatges SAML s'han de signar amb una signatura SAML. Valors possibles: 0 - (per defecte) No signar missatges; 1 - Signar missatges.< br> Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus SAML" |
| sign_logout_requests | integer | Si les peticions de tancament de sessió de SAML s'han de signar amb una signatura SAML. Valors possibles: 0 - (per defecte) No inicieu la sessió de peticions de tancament de sessió; 1 - Tanqueu la sessió. Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus SAML" |
| sign_logout_responses | integer | Si les respostes de tancament de sessió de SAML s'han de signar amb una signatura SAML. Valors possibles: 0 - (per defecte) No inicieu la sessió de respostes de tancament de sessió; 1 - Tanqueu la sessió respostes. Comportament de la propietat: - admès si idp_type és establert a "Directori d'usuari de tipus SAML" |
Mapatges de tipus de suport
L'objecte de mapatge de tipus de suport té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| userdirectory_mediaid | ID | ID del mapatge de tipus de suport. Comportament de la propietat: - només lectura |
| name | string | Nom visible a la llista de mapatges de tipus de suport. Comportament de la propietat: - obligatori |
| mediatypeid | ID | ID del tipus de suport que s'ha de crear; s'empra com a valor per a la propietat mediatypeid de l'objecte suport.Comportament de la propietat: - obligatori |
| attribute | string | Atribut del directori d'usuari LDAP/SAML (també atribut SCIM si scim_status s'estableix a "El subministrament SCIM és actiu") que conté el suport de l'usuari (per exemple, [email protected]) que s'empra com a valor per a la propietat sendto d'objecte suport.Si és present a les dades rebudes del proveïdor d'identitat LDAP/SAML, i el valor no és buit, això activarà la creació de suports per a l'usuari subministrat. Comportament de la propietat: - obligatori |
| active | integer | Propietat active de suport d'usuari quan el suport es crea per a l'usuari proveït.Valors possibles: 0 - (per defecte) actiu; 1 - desactivat. |
| severity | integer | Propietat severity del suport d'usuari, quan el suport es crea per a l'usuari proveït.Per defecte: 63. |
| period | string | Propietat period del suport d'usuari, quan el suport es crea per a l'usuari proveït.Per defecte: 1-7,00:00-24:00. |
Mapatge de grups de subministrament
Els mapatges de grups de subministrament tenen les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| name | string | Nom sencer d'un grup (p. ex., administradors Zabbix) al directori d'usuaris LDAP/SAML (també SCIM si scim_status s'estableix a "El subministrament SCIM és habilitat").Accepta el caràcter comodí "*". Únic en tots els mapatges de grups de subministrament. Comportament de la propietat: - obligatori |
| roleid | ID | ID de la funció d'usuari que s'ha d'assignar a l'usuari. Si coincideixen les assignacions de diversos grups de subministrament, la funció del tipus d'usuari més alt (Usuari, Administrador o Superadministrador) s'assigna a l'usuari. Si hi ha diversos rols amb el mateix tipus d'usuari, el primer rol (ordenat per ordre alfabètic) s'assigna a l'usuari. Comportament de la propietat:< br>- obligatori |
| user_groups | array | Matriu d'objectes d'ID de grup d'usuaris Zabbix. Cada objecte té les propietats següents:usrgrpid - (enter) ID del grup d'usuaris de Zabbix per assignar-lo a l'usuari.Si coincideixen els mapatges de diversos grups de subministrament, els grups d'usuaris de Zabbix de tots els mapatges que coincideixen s'assigna a l'usuari. Comportament de la propietat: - obligatori |