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:

{
           "jsonrpc": "2.0",
           "method": "user.provision",
           "params": [
               "1",
               "5"
           ],
           "id": 1
       }
Copy
✔ Copied

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "userids": [
                   "1",
                   "5"
               ]
           },
           "id": 1
       }
Copy
✔ Copied

Source

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.