nextcloud-api

Nextcloud Provisioning API

Overview

The Provisioning API enables external systems to create, edit, delete and query user attributes, manage groups, set quotas, query storage, and manage apps. Enabled by default. Uses the OCS API endpoint format.

Base URL: https://nextcloud.example.com/ocs/v1.php/cloud

Auth: Basic HTTP Auth (admin username:password) + OCS-APIRequest header

Headers (required for ALL calls):

• Authorization: Basic <base64(admin:password)>
• OCS-APIRequest: true
• POST requests also require Content-Type: application/x-www-form-urlencoded

Output format: XML by default. Append ?format=json for JSON.

Users

Add a New User

curl -X POST "https://nextcloud.example.com/ocs/v1.php/cloud/users" \
  -H "Authorization: Basic $(echo -n 'admin:password' | base64)" \
  -H "OCS-APIRequest: true" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "userid=newuser" \
  -d "password=SecurePass123!" \
  -d "displayName=New User" \
  -d "[email protected]" \
  -d "groups[]=admin" \
  -d "groups[]=group1" \
  -d "quota=10GB"

Status codes: 100=ok, 101=invalid, 102=already exists, 104=group missing

List Users

curl -X GET "https://nextcloud.example.com/ocs/v1.php/cloud/users?search=filter&limit=100&offset=0" \
  -H "Authorization: Basic $(echo -n 'admin:password' | base64)" \
  -H "OCS-APIRequest: true" | python3 -c "import sys, xml.etree.ElementTree as ET; print('\n'.join(e.text for e in ET.parse(sys.stdin).findall('.//users/element')))"

Get Single User

curl -X GET "https://nextcloud.example.com/ocs/v1.php/cloud/users/newuser" \
  -H "Authorization: Basic $(echo -n 'admin:password' | base64)" \
  -H "OCS-APIRequest: true" | python3 -c "
import sys, xml.etree.ElementTree as ET
root = ET.parse(sys.stdin).find('.//data')
for child in root:
    if child.tag == 'groups':
        print(f'{child.tag}: {[e.text for e in child]}')
    elif child.text and child.text.strip():
        print(f'{child.tag}: {child.text.strip()}')
"