[dokuwiki] New PR: Feature: add xmlrpc function to create new users

  • From: "satwareAG-ironMike" <wiki@xxxxxxxxxxxx>
  • To: dokuwiki@xxxxxxxxxxxxx
  • Date: Mon, 24 Jan 2022 02:19:10 +0100 (CET)

Hi,

satwareAG-ironMike opened a new pull request at 
https://github.com/splitbrain/dokuwiki/pull/3609:

Implements ApiCore functionality to add users by providing a 
`dokuwiki.createUsers` method.

Note on change in `inc/Remote/XmlRpcServer.php`: Errorhandling seems to be 
broken for all xmlrpc calls without changing the return type from Exceptions to 
the IXR Error Message.

Usage:
Provide an array of structs (see examples). user, name and mail are mandatory. 
If notify is set to true the user recieves a mail with his password. When 
providing an empty password in the sruct the system uses an auto-generated 
password. 

Example Array:
```
    $data = 
             [
                [
                    'user' => 'user1',
                    'password' => 'password1',
                    'name' => 'Jon Doe',
                    'mail' => 'jondoe@localhost',
                    'groups' => [
                        'user',
                        'test'
                    ],
                    'notify' => false
                ],
                [
                    'user' => 'user2',
                    'name' => 'Jane Doe',
                    'mail' => 'janedoe@localhost',
                    'groups' => [
                        'user',
                        'test'
                    ],
                    'notify' => true
                ],
            ];
```

Example XML request to add users:
```
<?xml version="1.0"?>
<methodCall>
    <methodName>dokuwiki.createUsers</methodName>
    <params>
        <param><value><array><data>
            <value><struct>
                
<member><name>user</name><value><string>user1</string></value></member>
                
<member><name>password</name><value><string>password1</string></value></member>
                <member><name>name</name><value><string>Jon 
Doe</string></value></member>
                
<member><name>mail</name><value><string>jondoe@localhost</string></value></member>
                <member><name>groups</name><value><array><data>
                    <value><string>user</string></value>
                    <value><string>test</string></value>
                </data></array></value></member>
                
<member><name>notify</name><value><boolean>0</boolean></value></member>
            </struct></value>
            <value><struct>
                
<member><name>user</name><value><string>user2</string></value></member>
                <member><name>name</name><value><string>Jane 
Doe</string></value></member>
                
<member><name>mail</name><value><string>janedoe@localhost</string></value></member>
                <member><name>groups</name><value><array><data>
                    <value><string>user</string></value>
                    <value><string>test</string></value>
                </data></array></value></member>
                
<member><name>notify</name><value><boolean>1</boolean></value></member>
            </struct></value>
        </data></array></value></param>
    </params>
</methodCall>
```

Example response
```
<?xml version="1.0"?>
<methodResponse>
    <params>
        <param>
            <value>
                <array><data>
                    <value><string>user1</string></value>
                    <value><string>user2</string></value>
                </data></array>
            </value>
        </param>
    </params>
</methodResponse>
```

Please help us to review this pull request, so new contributors get feedback in 
a timely manner.

a18c9d20-7cb3-11ec-8200-4e2c6f59212e


-- 
DokuWiki mailing list - more info at
http://www.dokuwiki.org/mailinglist

Other related posts:

  • » [dokuwiki] New PR: Feature: add xmlrpc function to create new users - satwareAG-ironMike