user.provision

Description

object user.provision(object/array users)

This method allows to provision LDAP users.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of users to provision.

Return values

(object) Returns an object containing the IDs of the provisioned users under the userids property.

Examples

Provisioning multiple users

Provision two users.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "user.provision",
  4.            "params": [
  5.                "1",
  6.                "5"
  7.            ],
  8.            "id": 1
  9.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "userids": [
  5.                    "1",
  6.                    "5"
  7.                ]
  8.            },
  9.            "id": 1
  10.        }

Source

CUser::provision() in ui/include/classes/api/services/CUser.php.