Sidebar

fr:manual:api:reference:user:create

user.create

Description

object user.create(object/array users)

Cette méthode permet de créer de nouveaux utilisateurs.

Paramètres

(object/array) Utilisateurs à créer.

En plus des propriétés de l'objet utilisateur standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
passwd
(obligatoire)
string Mot de passe de l'utilisateur.

Peut être vide si l'utilisateur est ajouté seulement à des groupes qui ont un accès via LDAP.
usrgrps
(obligatoire)
array Groupes d'utilisateurs auxquels l'utilisateur doit être ajouté.

Les groupes d'utilisateurs doivent avoir la propriété usrgrpid définie.
user_medias array Médias à créer pour l'utilisateur.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des utilisateurs créés sous la propriété userids. L'ordre des ID retournés correspond à l'ordre des utilisateurs transmis.

Exemples

Création d'un utilisateur

Créer un nouvel utilisateur, l'ajouter à un groupe d'utilisateurs et créer un nouveau média pour lui.

Requête :

{
    "jsonrpc": "2.0",
    "method": "user.create",
    "params": {
        "alias": "John",
        "passwd": "Doe123",
        "usrgrps": [
            {
                "usrgrpid": "7"
            }
        ],
        "user_medias": [
            {
                "mediatypeid": "1",
                "sendto": [
                    "[email protected]"
                ],
                "active": 0,
                "severity": 63,
                "period": "1-7,00:00-24:00"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "12"
        ]
    },
    "id": 1
}

Voir également

Source

CUser::create() dans frontends/php/include/classes/api/services/CUser.php.