[comment]: # aside:1

[comment]: # ({c9088bab-f9e8f670})
# Objecte directori d'usuaris

Els objectes següents són relacionats directament amb l'API `userdirectory`.

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

[comment]: # ({57811c28-ad144502})
### Directori d'usuari

El directori d'usuari té les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data-types)|Descripció|
|--|--|------|
|userdirectoryid|ID|ID del directori d'usuari.<br><br>Si s'esborra un directori d'usuari, el valor de la propietat [User object](/manual/api/reference/user/object#user) `userdirectoryid` s'estableix a "0" per a tots els usuaris que són enllaçats al directori d'usuaris esborrat.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *només lectura* <br>- *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.<br>Tingueu en compte que només pot existir un directori d'usuaris de tipus SAML.<br><br>Valors possibles:<br>1 -Directori d'usuaris de tipus LDAP;<br>2 -Directori d'usuaris de tipus SAML.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Exemple: *cn*<br><br>[Comportament de la propietat ](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `provision_status` s'estableix a "Activat" i `saml_jit_status` d'[Objecte d'autenticació](/manual/api/reference/authentication/ object#authentication) 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](/manual/ api/reference/user/object#user) propietat `name` quan s'aprovisiona l'usuari.<br><br>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](/manual /api/reference/user/object#user) propietat `cognom` quan s'aprovisiona l'usuari.<br><br>Exemples: *sn*, *surname*, *lastName*|
|provision_status|integer|Estat d'aprovisionament del directori d'usuaris.<br><br>Valors possibles:<br>0 - *(per defecte)* Inhabilitat (l'aprovisionament dels usuaris creats per aquest directori d'usuaris és desactivat);<br>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ó](/manual/api/reference/authentication/object#authentication))) s'ha d'habilitar).|
|provision_groups|array|Matriu d'objectes [mapatges de grups d'aprovisionament](object#provisioning_groups_mappings) per associar el patró de grup d'usuaris LDAP/SAML al grup d'usuaris i rol d'usuari Zabbix.<br><br>[Comportament de la propietat](/manual/api/ reference_commentary#property-behavior):<br>- *obligatori* si `provision_status` és establert com a "Activat"|
|provision_media|array|Matriu de [mapatges de tipus de suport](object#media_type_mappings) 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](/manual/web_interface/frontend_sections/users/authentication/ldap):**|<|<|
|name|string|Nom únic del directori d'usuari.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `idp_type` és establert a " Directori d'usuaris de tipus LDAP"|
|host|string|Nom d'equip, IP o URI del servidor LDAP.<br>l'URI ha de contindre l'esquema (`ldap://` o `ldaps://`), l'equip i el port (opcional).<br><br>Exemples:<br>*equip.exemple.com*<br>*127.0.0.1*<br>*ldap://ldap.example.com:389*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `idp_type` és establert a "Directori d'usuari de tipus LDAP"|
|port|integer|Port del servidor LDAP.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Exemples:<br>*ou=Usuaris,dc=exemple,dc=org*<br>*ou=Usuaris,ou=sistema* (per a OpenLDAP)<br>*DC=company,DC=com* (per a Microsoft Active Directory)<br>*uid=%{user},dc=example,dc=com* (per a l'enllaç directe d'usuari; marcador de posició "*%{user}*" és obligatori)<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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ó.<br><br>Exemples:<br>*uid* (per a OpenLDAP)<br>*sAMAccountName* (per a Microsoft Active Directory)<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Per a l'enllaç directe d'usuari i l'enllaç anònim, `bind_dn` ha de ser buit.<br><br>Exemples:<br>*uid=ldap_search,ou=system* (per a OpenLDAP)<br>*CN=ldap_search,OU=grup_usuaris,DC=empresa,DC=com* (per a Microsoft Active Directory)<br>*CN=Administrador,OU=Usuaris,OU=Zabbix,DC=zbx,DC=local*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Per a l'enllaç directe d'usuari i l'enllaç anònim, `bind_password` ha de ser buit.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `idp_type` és establert a "Directori d'usuaris de tipus LDAP"|
|description|string|Descripció del directori d'usuaris.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>S'ignora quan s'aprovisiona un usuari si s'ha definit `group_membership`.<br><br>Exemple: *ou=Groups,dc=example,dc=com*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>S'ignora quan s'aprovisiona un usuari si s'ha definit `group_membership`.<br><br>Reservadors de posició `group_filter` admesos:<br>*%{attr}* - atribut de cerca (substituït pel valor de propietat `search_attribute`);<br>*%{groupattr}* - atribut de grup (substituït pel valor de propietat `group_member`);<br>*%{host}* - nom d'equip, IP o URI del servidor LDAP (substituït pel valor de la propietat `host`);<br>*%{user}* - nom d'usuari de l'usuari Zabbix.<br><br>Per defecte: *(%{groupattr}=% {usuari})*<br><br>Exemples:<br>- *(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;<br>- *(%{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.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>S'ignora quan s'aprovisiona un usuari si s'ha definit `group_membership`.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property -behavior):<br>- *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.<br><br>Exemple: *memberOf*<br><br>[Comportament de la propietat](/manual/api/reference_commentary# property-behavior):<br>- *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ó.<br><br>Reservadors de posició `search_filter` admesos:<br>*%{attr}* - nom de l'atribut de cerca (p. ex., *uid*, *sAMAccountName*);<br>*%{user}* - nom d'usuari de Zabbix.<br><br>Per defecte: *(%{attr}=%{user})*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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).<br><br>Tingueu en compte que `start_tls` s'ha d'establir com a "Desactivat" per als equips que empren el Protocol `ldaps://`.<br><br>Valors possibles:<br>0 - *(per defecte)* Desactivat;<br>1 - Activat.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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`.<br><br>Exemples: *cn* , *uid*, *member*, *uniqueMember*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `idp_type` és establert a "Directori d'usuaris de tipus LDAP"|
|**[SAML](/manual/web_interface/frontend_sections/users/authentication/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.<br><br>Exemple: *https://idp.example.com/idp*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Exemples:<br>*https://idp.example.com/sp*<br>*zabbix*<br> <br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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](/manual/api/reference/user/object#user) quan s'autentica.<br><br>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*<br><br><br>[Comportament de propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Exemple: *http://idp.example.com/idp/sso/saml*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Exemple: *https://idp.example.com/idp/slo/saml*<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 -*(per defecte)* No encripteu l'ID de nom;<br>1 - Encripteu l'ID de nom.<br ><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 - *(per defecte)* No encripteu les afirmacions;<br>1 - Encripteu les afirmacions.<br><br >[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Exemples:<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>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 - *(per defecte)* El subministrament SCIM és desactivat;<br>1 - El subministrament SCIM és habilitat.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 - *(per defecte)* No signar assercions;<br>1 - Signar assercions.< br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 - *(per defecte)* No signar peticions d'autenticació;<br>1 - Signa peticions d'autenticació.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 - *(per defecte)* No signar missatges;<br>1 - Signar missatges.< br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 - *(per defecte)* No inicieu la sessió de peticions de tancament de sessió;<br>1 - Tanqueu la sessió.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valors possibles:<br>0 - *(per defecte)* No inicieu la sessió de respostes de tancament de sessió;<br>1 - Tanqueu la sessió respostes.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `idp_type` és establert a "Directori d'usuari de tipus SAML"|

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

[comment]: # ({07d3d820-c2b51996})
#### Mapatges de tipus de suport

L'objecte de mapatge de tipus de suport té les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data-types)|Descripció|
|--|--|-----------------|
|userdirectory_mediaid|ID|ID del mapatge de tipus de suport.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *només lectura*|
|name|string|Nom visible a la llista de mapatges de tipus de suport.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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](/manual/api/reference/user/object#media).<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *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, *usuari@example.com*) que s'empra com a valor per a la propietat `sendto` d'[objecte suport](/manual/api/reference/user/object#media).<br><br>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.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori*|
|active|integer|Propietat `active` de suport d'usuari quan el suport es crea per a l'usuari proveït.<br><br>Valors possibles:<br>0 - *(per defecte)* actiu;<br>1 - desactivat.|
|severity|integer|Propietat `severity` del suport d'usuari, quan el suport es crea per a l'usuari proveït.<br><br>Per defecte: 63.|
|period|string|Propietat `period` del suport d'usuari, quan el suport es crea per a l'usuari proveït.<br><br>Per defecte: 1-7,00:00-24:00.|

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

[comment]: # ({fe544518-67bd0ce1})
#### Mapatge de grups de subministrament

Els mapatges de grups de subministrament tenen les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data-types)|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").<br>Accepta el caràcter comodí "\*".<br>Únic en tots els mapatges de grups de subministrament.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori*|
|roleid|ID|ID de la funció d'usuari que s'ha d'assignar a l'usuari.<br><br>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.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):< br>- *obligatori*|
|user_groups|array|Matriu d'objectes d'ID de grup d'usuaris Zabbix. Cada objecte té les propietats següents:<br>`usrgrpid` - `(enter)` ID del grup d'usuaris de Zabbix per assignar-lo a l'usuari.<br><br>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.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori*|

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