sudo -u 
Enter a new password:
Confirm the new password:
Successfully reset password for admin

'lost_password_link' => 'https://IFC.com/link/to/password/reset',

<?php

"user_backends" => array (
    0 => array (
            "class"     => ...,
            "arguments" => array (
                              0 => ...
                              ),
    ),
),

<?php

"user_backends" => array (
    0 => array (
            "class"     => "OC_User_IMAP",
            "arguments" => array (
                              0 => '{imap.gmail.com:993/imap/ssl}'
                              ),
    ),
),

<?php

"user_backends" => array (
    0 => array (
            "class"     => "OC_User_SMB",
            "arguments" => array (
                              0 => 'localhost'
                              ),
    ),
),

<?php

"user_backends" => array (
    0 => array (
            "class"     => "OC_User_FTP",
            "arguments" => array (
                              0 => 'localhost'
                              ),
    ),
),

 

User Provisioning API

The Provisioning API application enables a set of APIs that external systems can use to create,edit, delete and query user attributes, query, set and remove groups, set quotaand query total storage used in Nextcloud. Group admin users can also queryNextcloud and perform the same functions as an admin for groups they manage. TheAPI also enables an admin to query for active Nextcloud applications, applicationinfo, and to enable or disable an app remotely. HTTPrequests can be used via a Basic Auth header to perform any of the functionslisted above. The Provisioning API app is enabled by default.

The base URL for all calls to the share API is nextcloud_base_url/ocs/v1.php/cloud.

All calls to OCS endpoints require the OCS-APIRequest header to be set to true.

All POST requests require the Content-Type: application/x-www-form-urlencoded header. (Note: Some libraries like Curl set this header automatically, other require to set the header explicitly)

 

Instruction Set For Users

Add a new user

Create a new user on the Nextcloud server. Authentication is done by sending abasic HTTP authentication header.

Syntax: ocs/v1.php/cloud/users

• HTTP method: POST
• POST argument: userid - string, the required username for the new user
• POST argument: password - string, the required password for the new user

Status codes:

• 100 - successful
• 101 - invalid input data
• 102 - username already exists
• 103 - unknown error occurred whilst adding the user
• 104 - group does not exist
• 105 - insufficient privileges for group
• 106 - no group specified (required for subadmins)
• 107 - all errors that contain a hint - for example “Password is among the 1,000,000 most common ones. Please make it unique.” (this code was added in 12.0.6 & 13.0.1)

Example

• POST http://admin:secret@example.com/ocs/v1.php/cloud/users -duserid="Frank" -d password="frankspassword"
• Creates the user Frank with password frankspassword

XML Output

<?xml version="1.0"?>
<ocs>
 <meta>
  <status>ok</status>
  <statuscode>100</statuscode>
  <message/>
 </meta>
 <data/>
</ocs>

Search/get users

Retrieves a list of users from the Nextcloud server. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users

• HTTP method: GET
• url arguments: search - string, optional search string
• url arguments: limit - int, optional limit value
• url arguments: offset - int, optional offset value

Status codes:

• 100 - successful

Example

• GET http://admin:secret@example.com/ocs/v1.php/cloud/users?search=Frank
• Returns list of users matching the search string.

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <users>
      <element>Frank</element>
     </users>
  </data>
</ocs>

Get data of a single user

Retrieves information about a single user. Authentication is done by sending aBasic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}

• HTTP method: GET

Status codes:

• 100 - successful

Example

• GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank
• Returns information on the user Frank

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <enabled>true</enabled>
    <id>Frank</id>
    <quota>0</quota>
    <email>frank@example.org</email>
    <displayname>Frank K.</displayname>
    <phone>0123 / 456 789</phone>
    <address>Foobar 12, 12345 Town</address>
    <website>https://nextcloud.com</website>
    <twitter>Nextcloud</twitter>
    <groups>
     <element>group1</element>
     <element>group2</element>
    </groups>
  </data>
</ocs>

Edit data of a single user

Edits attributes related to a user. Users are able to edit email, displaynameand password; admins can also edit the quota value. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}

• HTTP method: PUT
• PUT argument: key, the field to edit:
  • email
  • quota
  • displayname
  • display (deprecated use displayname instead)
  • phone
  • address
  • website
  • twitter
  • password
• PUT argument: value, the new value for the field

Status codes:

• 100 - successful
• 101 - user not found
• 102 - invalid input data

Examples

• PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -dkey="email" -d value="franksnewemail@example.org"
• Updates the email address for the user Frank
• PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -dkey="quota" -d value="100MB"
• Updates the quota for the user Frank

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Disable a user

Disables a user on the Nextcloud server so that the user cannot login anymore.Authentication is done by sending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/disable

• HTTP method: PUT

Statuscodes:

• 100 - successful
• 101 - failure

Example

• PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/disable
• Disables the user Frank

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <status>ok</status>
    <statuscode>100</statuscode>
    <message/>
  </meta>
  <data/>
</ocs>

Enable a user

Enables a user on the Nextcloud server so that the user can login again.Authentication is done by sending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/enable

• HTTP method: PUT

Statuscodes:

• 100 - successful
• 101 - failure

Example

• PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/enable
• Enables the user Frank

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <status>ok</status>
    <statuscode>100</statuscode>
    <message/>
  </meta>
  <data/>
</ocs>

Delete a user

Deletes a user from the Nextcloud server. Authentication is done by sending aBasic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}

• HTTP method: DELETE

Statuscodes:

• 100 - successful
• 101 - failure

Example

• DELETE http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank
• Deletes the user Frank

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Get user’s groups

Retrieves a list of groups the specified user is a member of. Authentication isdone by sending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/groups

• HTTP method: GET

Status codes:

• 100 - successful

Example

• GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups
• Retrieves a list of groups of which Frank is a member

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <groups>
      <element>admin</element>
      <element>group1</element>
    </groups>
  </data>
</ocs>

 

Add user to group

Adds the specified user to the specified group. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/groups

• HTTP method: POST
• POST argument: groupid, string - the group to add the user to

Status codes:

• 100 - successful
• 101 - no group specified
• 102 - group does not exist
• 103 - user does not exist
• 104 - insufficient privileges
• 105 - failed to add user to group

Example

• POST http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups-d groupid="newgroup"
• Adds the user Frank to the group newgroup

 

XML Output

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

 

Remove user from group

Removes the specified user from the specified group. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/groups

• HTTP method: DELETE
• DELETE argument: groupid, string - the group to remove the user from

Status codes:

• 100 - successful
• 101 - no group specified
• 102 - group does not exist
• 103 - user does not exist
• 104 - insufficient privileges
• 105 - failed to remove user from group

 

Example

• DELETEhttp://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -dgroupid="newgroup"
• Removes the user Frank from the group newgroup

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

 

 

 

 

 

Promote user to subadmin

Makes a user the subadmin of a group. Authentication is done by sending a BasicHTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/subadmins

• HTTP method: POST
• POST argument: groupid, string - the group of which to make the user asubadmin

Status codes:

• 100 - successful
• 101 - user does not exist
• 102 - group does not exist
• 103 - unknown failure

 

Example

• POSThttps://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins-d groupid="group"
• Makes the user Frank a subadmin of the group group

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

 

Demote user from subadmin

Removes the subadmin rights for the user specified from the group specified.Authentication is done by sending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/subadmins

• HTTP method: DELETE
• DELETE argument: groupid, string - the group from which to remove the user’ssubadmin rights

Status codes:

• 100 - successful
• 101 - user does not exist
• 102 - user is not a subadmin of the group / group does not exist
• 103 - unknown failure

 

Example

• DELETEhttps://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins-d groupid="oldgroup"
• Removes Frank's subadmin rights from the oldgroup group

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

 

Get user’s subadmin groups

Returns the groups in which the user is a subadmin. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/users/{userid}/subadmins

• HTTP method: GET

Status codes:

• 100 - successful
• 101 - user does not exist
• 102 - unknown failure

 

Example

• GEThttps://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins
• Returns the groups of which Frank is a subadmin

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
      <status>ok</status>
      <statuscode>100</statuscode>
    <message/>
  </meta>
  <data>
    <element>testgroup</element>
  </data>
</ocs>

 

 

 

 

 

Resend the welcome email

The request to this endpoint triggers the welcome email for this user again.

Syntax: ocs/v1.php/cloud/users/{userid}/welcome

• HTTP method: POST

Status codes:

• 100 - successful
• 101 - email address not available
• 102 - sending email failed

 

Example

• POSThttps://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/welcome
• Sends the welcome email to Frank

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
      <status>ok</status>
      <statuscode>100</statuscode>
    <message/>
  </meta>
  <data/>
</ocs>

 

 

Instruction Set For Groups

 

Search/get groups

Retrieves a list of groups from the Nextcloud server. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/groups

• HTTP method: GET
• url arguments: search - string, optional search string
• url arguments: limit - int, optional limit value
• url arguments: offset - int, optional offset value

Status codes:

• 100 - successful

 

Example

• GET http://admin:secret@example.com/ocs/v1.php/cloud/groups?search=adm
• Returns list of groups matching the search string.

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <groups>
      <element>admin</element>
    </groups>
  </data>
</ocs>

 

Create a group

Adds a new group. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/groups

• HTTP method: POST
• POST argument: groupid, string - the new groups name

Status codes:

• 100 - successful
• 101 - invalid input data
• 102 - group already exists
• 103 - failed to add the group

 

Example

• POST http://admin:secret@example.com/ocs/v1.php/cloud/groups -dgroupid="newgroup"
• Adds a new group called newgroup

XML Output

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

 

Get members of a group

Retrieves a list of group members. Authentication is done by sending a BasicHTTP Authorization header.

Syntax: ocs/v1.php/cloud/groups/{groupid}

• HTTP method: GET

Status codes:

• 100 - successful

 

Example

• POST http://admin:secret@example.com/ocs/v1.php/cloud/groups/admin
• Returns a list of users in the admin group

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <users>
      <element>Frank</element>
    </users>
  </data>
</ocs>

 

Get subadmins of a group

Returns subadmins of the group. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/groups/{groupid}/subadmins

• HTTP method: GET

Status codes:

• 100 - successful
• 101 - group does not exist
• 102 - unknown failure

 

Example

• GEThttps://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup/subadmins
• Return the subadmins of the group: mygroup

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <status>ok</status>
    <statuscode>100</statuscode>
    <message/>
  </meta>
  <data>
    <element>Tom</element>
  </data>
</ocs>

Delete a group

Removes a group. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/groups/{groupid}

• HTTP method: DELETE

Status codes:

• 100 - successful
• 101 - group does not exist
• 102 - failed to delete group

 

Example

• DELETE http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup
• Delete the group mygroup

XML Output

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

 

Instruction Set For Apps

 

Getlist of apps

Returns a list of apps installed on the Nextcloud server. Authentication is doneby sending a Basic HTTP Authorizationheader.

Syntax: ocs/v1.php/cloud/apps/

• HTTP method: GET
• url argument: filter, string - optional (enabled or disabled)

Status codes:

• 100 - successful
• 101 - invalid input data

 

Example

• GET http://admin:secret@example.com/ocs/v1.php/cloud/apps?filter=enabled
• Gets enabled apps

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <apps>
      <element>files</element>
      <element>provisioning_api</element>
    </apps>
  </data>
</ocs>

 

 

 

 

 

Get app info

Provides information on a specific application. Authentication is done bysending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/apps/{appid}

• HTTP method: GET

Status codes:

• 100 - successful

 

Example

• GET http://admin:secret@example.com/ocs/v1.php/cloud/apps/files
• Get app info for the files app

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <info/>
    <remote>
      <files>appinfo/remote.php</files>
      <webdav>appinfo/remote.php</webdav>
      <filesync>appinfo/filesync.php</filesync>
    </remote>
    <public/>
    <id>files</id>
    <name>Files</name>
    <description>File Management</description>
    <licence>AGPL</licence>
    <author>Robin Appelman</author>
    <require>4.9</require>
    <shipped>true</shipped>
    <standalone></standalone>
    <default_enable></default_enable>
    <types>
      <element>filesystem</element>
    </types>
  </data>
</ocs>

 

 

 

 

 

Enable an app

Enable an app. Authentication is done by sending a Basic HTTP Authorizationheader.

Syntax: ocs/v1.php/cloud/apps/{appid}

• HTTP method: POST

Status codes:

• 100 - successful

 

Example

• POST http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor
• Enable the files_texteditor app

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
</ocs>

 

 

 

 

 

Disable an app

Disables the specified app. Authentication isdone by sending a Basic HTTP Authorization header.

Syntax: ocs/v1.php/cloud/apps/{appid}

• HTTP method: DELETE

Status codes:

• 100 - successful

 

Example

• DELETE http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor
• Disable the files_texteditor app

 

 

XML Output

 

 

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
</ocs>