userdirectory.create

Descrição

object userdirectory.create(object/array userDirectory)

Este método permite criar novos diretórios de usuários.

Parâmetros

(object/array) Diretórios de usuário a serem criados.

O método aceita diretórios de usuário com as propriedades padrão do diretório de usuário.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos diretórios de usuários criados na propriedade userdirectoryids. A ordem dos IDs retornados corresponde à ordem dos diretórios de usuários passados.

Exemplos

Criando um diretório de usuários

Crie um diretório de usuários para autenticar usuários com StartTLS via LDAP. Observe que, para autenticar usuários via LDAP, a autenticação LDAP deve estar habilitada.

Requisição:

{
    "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
}

Resposta:

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

Criando um diretório de usuários (provisionamento JIT ativado)

Crie um diretório de usuários para autenticar usuários via LDAP (com provisionamento JIT ativado). Observe que, para autenticar usuários via LDAP, a autenticação LDAP deve estar ativada.

Requisição:

{
    "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
}

Resposta:

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

Fonte

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