userdirectory.create

Beschreibung

object userdirectory.create(object/array userDirectory)

Diese Methode ermöglicht das Erstellen neuer Benutzerverzeichnisse.

Parameter

(object/array) Zu erstellende Benutzerverzeichnisse.

Die Methode akzeptiert Benutzerverzeichnisse mit den Standard-Benutzerverzeichniseigenschaften.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der erstellten Benutzerverzeichnisse in der Eigenschaft userdirectoryids enthält. Die Reihenfolge der zurückgegebenen IDs entspricht der Reihenfolge der übergebenen Benutzerverzeichnisse.

Beispiele

Erstellen eines Benutzerverzeichnisses

Erstellen Sie ein Benutzerverzeichnis, um Benutzer mit StartTLS über LDAP zu authentifizieren. Beachten Sie, dass zur Authentifizierung von Benutzern über LDAP die LDAP-Authentifizierung aktiviert sein muss.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "userdirectory.create",
    "params": {
        "idp_type": "1",
        "name": "LDAP API server #1",
        "host": "ldap://local.ldap",
        "port": "389",
        "base_dn": "ou=Users,dc=example,dc=org",
        "bind_dn": "cn=ldap_search,dc=example,dc=org",
        "bind_password": "ldapsecretpassword",
        "search_attribute": "uid",
        "start_tls": "1"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "userdirectoryids": [
            "3"
        ]
    },
    "id": 1
}

Erstellen eines Benutzerverzeichnisses (JIT-Provisionierung aktiviert)

Erstellen Sie ein Benutzerverzeichnis, um Benutzer über LDAP zu authentifizieren (mit aktivierter JIT-Provisionierung). Beachten Sie, dass zur Authentifizierung von Benutzern über LDAP die LDAP-Authentifizierung aktiviert sein muss.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "userdirectory.create",
    "params": {
            "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": [
                {
                    "name": "example.com",
                    "mediatypeid": "1",
                    "attribute": "[email protected]"
                }
            ],
            "provision_groups": [
                {
                    "name": "*",
                    "roleid": "4",
                    "user_groups": [
                        {
                            "usrgrpid": "8"
                        }
                    ]
                },
                {
                    "name": "Zabbix administrators",
                    "roleid": "2",
                    "user_groups": [
                        {
                            "usrgrpid": "7"
                        },
                        {
                            "usrgrpid": "8"
                        }
                    ]
                }
            ]
        },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "userdirectoryids": [
            "2"
        ]
    },
    "id": 1
}

Quelle

CUserDirectory::create() in ui/include/classes/api/services/CUserDirectory.php.