Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nextcloud Users API

The Users API from Nextcloud — 2 operation(s) for users.

Nextcloud Users API is one of 6 APIs that Nextcloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.

Requests are made against a single base URL, https://your-nextcloud.example.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://your-nextcloud.example/ocs/v2.php
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nextcloud Users API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BasicAuth — Username + password or username + app token
  • BearerAuth — OIDC bearer token issued by an external identity provider

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Users 2
GET
/ocs/v1.php/cloud/users
List all user IDs (admin only)
5 params → 200
GET
/ocs/v1.php/cloud/users/{userId}
Retrieve user metadata
3 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is OcsEnvelope (1 property). Each schema is shown below with its type and property counts.

OcsEnvelope
object
Standard OCS response envelope
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nextcloud-users-api-openapi.yml Raw ↑

Other APIs Nextcloud publishes across the network.

Nextcloud OCS API
Nextcloud WebDAV API
Nextcloud Autocomplete API
Nextcloud Capabilities API
Nextcloud DAV API