[comment]: # ({53d969c5-f9e8f670})
# userdirectory.get

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

[comment]: # ({f09e8f55-b5ff62ed})
### Descripció

`integer/array userdirectory.get(object parameters)`

El mètode permet recuperar directoris d'usuari segons els paràmetres donats.

::: noteclassic
Aquest mètode només és disponible per als tipus d'usuaris *Superadministrador*.
:::

[comment]: # ({/f09e8f55-b5ff62ed})

[comment]: # ({05235115-d99c84a0})
### Paràmetres

`(objecte)` Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|userdirectoryids|ID/array|Retorna només els directoris d'usuari amb els ID donats.|
|selectUsrgrps|query|Retorna una propietat `usrgrps` amb [grups d'usuaris](/manual/api/reference/usergroup/object) associats a un directori d'usuaris.<br><br>Admet `count`.|
|selectProvisionMedia|query|Retorna una propietat `provision_media` amb [mapatges de tipus de suport](/manual/api/reference/userdirectory/object#media-type-mappings) associat a un directori d'usuari.|
|selectProvisionGroups|query|Retorna una propietat `provisioning_groups` amb [mapatges de grups d'aprovisionament](/manual/api/reference/userdirectory/object#provisioning-groups-mappings) associada a un directori d'usuari.|
|sortfield|string/array|Ordena el resultat per les propietats donades.<br><br>Valors possibles: `name`.|
|filter|object|Retorna només els resultats que coincideixen exactament amb el filtre donat.<br><br>Accepta un objecte, on les claus són els noms de propietat i els valors són un valor únic o una matriu de valors.<br> <br>Claus admeses: `userdirectoryid`, `idp_type`, `provision_status`.|
|search|object|Retorna resultats que coincideixen amb el patró donat (no distingeix entre majúscules i minúscules).<br><br>Admet un objecte, on la clau és nom de la propietat, i els valors són cadenes on fer la cerca. Si no es donen opcions addicionals, farà una cerca de tipus `LIKE  "%...%"`.<br><br>Admet les propietats: `name`, `description`.<br><br>El directori d'usuari del tipus SAML tindrà un lloc buit valor tant per als camps `name` com per a `description`. Tots dos camps es poden canviar amb l'operació `userdirectory.update`.|
|countOutput|boolean|Aquests paràmetres es descriuen en detall al [comentari de referència](/manual/api/reference_commentary#common_get_method_parameters).|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/05235115-d99c84a0})

[comment]: # ({7223bab1-a18ff82b})
### Valors de retorn

`(integer/array)` Retorna un d'entre:

-   una taula d'objectes;
-   el recompte d'objectes recuperats, si s'empra el paràmetre `countOutput`.

[comment]: # ({/7223bab1-a18ff82b})

[comment]: # ({b41637d2-ba1c8d4c})
### Exemples

[comment]: # ({/b41637d2-ba1c8d4c})

[comment]: # ({dee71092-6acef378})
##### Recuperar els directoris d'usuaris

Recupera tots els directoris amb propietats addicionals que ensenyen els mapatges de tipus de suport i els mapatges de grups d'aprovisionament associats amb cada directori d'usuari.

[Petició](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "userdirectory.get",
    "params": {
        "output": "extend",
        "selectProvisionMedia": "extend",
        "selectProvisionGroups": "extend"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
       {
            "userdirectoryid": "1",
            "idp_type": "2",
            "name": "",
            "provision_status": "1",
            "description": "",
            "group_name": "groups",
            "user_username": "",
            "user_lastname": "",
            "idp_entityid": "http://example.com/simplesaml/saml2/idp/metadata.php",
            "sso_url": "http://example.com/simplesaml/saml2/idp/SSOService.php",
            "slo_url": "",
            "username_attribute": "uid",
            "sp_entityid": "zabbix",
            "nameid_format": "",
            "sign_messages": "0",
            "sign_assertions": "0",
            "sign_authn_requests": "0",
            "sign_logout_requests": "0",
            "sign_logout_responses": "0",
            "encrypt_nameid": "0",
            "encrypt_assertions": "0",
            "scim_status": "1",
            "provision_media": [
                {
                    "userdirectory_mediaid": "1",
                    "name": "example.com",
                    "mediatypeid": "1",
                    "attribute": "user@example.com",
                    "active": "0",
                    "severity": "63",
                    "period": "1-7,00:00-24:00"
                }
            ],
            "provision_groups": [
                {
                    "name": "*",
                    "roleid": "1",
                    "user_groups": [
                        {
                            "usrgrpid": "13"
                        }
                    ]
                }
            ]
        },
        {
            "userdirectoryid": "2",
            "idp_type": "1",
            "name": "AD server",
            "provision_status": "1",
            "description": "",
            "host": "host.example.com",
            "port": "389",
            "base_dn": "DC=zbx,DC=local",
            "search_attribute": "sAMAccountName",
            "bind_dn": "CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local",
            "start_tls": "0",
            "search_filter": "",
            "group_basedn": "OU=Zabbix,DC=zbx,DC=local",
            "group_name": "CN",
            "group_member": "member",
            "group_filter": "(%{groupattr}=CN=%{ref},OU=Users,OU=Zabbix,DC=zbx,DC=local)",
            "group_membership": "",
            "user_username": "givenName",
            "user_lastname": "sn",
            "user_ref_attr": "CN",
            "provision_media": [
                {
                    "userdirectory_mediaid": "2",
                    "name": "example.com",
                    "mediatypeid": "1",
                    "attribute": "user@example.com",
                    "active": "0",
                    "severity": "63",
                    "period": "1-7,00:00-24:00"
                }
            ],
            "provision_groups": [
                {
                    "name": "*",
                    "roleid": "4",
                    "user_groups": [
                        {
                            "usrgrpid": "8"
                        }
                    ]
                },
                {
                    "name": "Zabbix administrators",
                    "roleid": "2",
                    "user_groups": [
                        {
                            "usrgrpid": "7"
                        },
                        {
                            "usrgrpid": "8"
                        }
                    ]
                }
            ]
        },
        {
            "userdirectoryid": "3",
            "idp_type": "1",
            "name": "LDAP API server #1",
            "provision_status": "0",
            "description": "",
            "host": "ldap://local.ldap",
            "port": "389",
            "base_dn": "ou=Users,dc=example,dc=org",
            "search_attribute": "uid",
            "bind_dn": "cn=ldap_search,dc=example,dc=org",
            "start_tls": "1",
            "search_filter": "",
            "group_basedn": "",
            "group_name": "",
            "group_member": "",
            "group_filter": "",
            "group_membership": "",
            "user_username": "",
            "user_lastname": "",
            "user_ref_attr": "",
            "provision_media": [],
            "provision_groups": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/dee71092-6acef378})

[comment]: # ({860ec55f-5f3bc200})
### Veieu també

-   [Grup d'usuaris](/manual/api/reference/group/object#user)

[comment]: # ({/860ec55f-5f3bc200})

[comment]: # ({901c82dd-392498dd})
### Font

CUserDirectory::get() a *ui/include/classes/api/services/CUserDirectory.php*.

[comment]: # ({/901c82dd-392498dd})