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

Nuxeo User API

User Operations

Nuxeo User API is one of 22 APIs that Nuxeo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 8 operations across 6 paths, and defines 6 schemas. It is described by OpenAPI 3.0.2, at version LTS 2021.

Requests are made against 2 base URLs: https://{host}:{port}/nuxeo/api/v1, https://nightly.nuxeo.com/nuxeo/api/v1.

8 operations 6 paths 6 schemas 1 DELETE3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
LTS 2021
Base URL
https://{nuxeo-server}/nuxeo/api/v1
Authentication
HTTP Basic, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nuxeo User API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_auth). An API key is passed in the header as X-Authentication-Token (token).

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

User 8

User Operations

GET
/me
Get the logged in user
MeGet → 200401404
PUT
/me/changepassword
Change the logged in user's password
MePasswordPut body → 200401404
POST
/user
Create a user
UserPost body → 200401404
GET
/user/search
Get a user by its name
UserSearchGet 1 param → 200401404
DELETE
/user/{userName}
Delete a user by its name
UserByNameDelete 1 param → 200401404
GET
/user/{userName}
Get a user by its name
UserByNameGet 1 param → 200401404
PUT
/user/{userName}
Update a user by its name
UserByNamePut 1 param body → 200401404
POST
/user/{userName}/group/{groupName}
Add a group to a user
UserAddGroupPost 2 params → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are documents (19 properties), Document (13 properties), user (6 properties), GroupRef (3 properties). Each schema is shown below with its type and property counts.

Document
object
13 properties 1 required
documents
object
19 properties 2 required
user
object
6 properties 4 required
changePassword
object
2 properties 2 required
GroupRef
object
3 properties 3 required
Property
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-user-api-openapi.yml Raw ↑

Other APIs Nuxeo publishes across the network.

Nuxeo ACL API
Nuxeo Adapter API
Nuxeo Annotation API
Nuxeo Audit API
Nuxeo Automation API
Nuxeo Blob API
Nuxeo Business Object API
Nuxeo Children API
Nuxeo Configuration API
Nuxeo Conversion API
Nuxeo Directory API
Nuxeo Document API