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 OAuth2 API

OAuth2 Operations

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

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

This API exposes 21 operations across 12 paths, and defines 7 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.

21 operations 12 paths 7 schemas 3 DELETE12 GET2 POST4 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 OAuth2 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 21

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

OAuth2 21

OAuth2 Operations

GET
/oauth2/client
Retrieves a OAuth2 client.
OAuth2ClientGet → 200401404
POST
/oauth2/client
Adds an OAuth2 client.
OAuth2ClientPost body → 200401404
DELETE
/oauth2/client/{oauth2ClientId}
Deletes an OAuth2 client token.
OAuth2ClientIdDelete 1 param → 200401404
GET
/oauth2/client/{oauth2ClientId}
Retrieves an OAuth2 client.
OAuth2ClientIdGet 1 param → 200401404
PUT
/oauth2/client/{oauth2ClientId}
Update an OAuth2 client.
OAuth2ClientIdPut 1 param body → 200401404
GET
/oauth2/provider
Retrieves the list of available OAuth2 providers.
OAuth2ProviderGet → 200401404
POST
/oauth2/provider
Adds an OAuth2 provider.
OAuth2ProviderPost body → 200401404
GET
/oauth2/provider/{oauth2ProviderId}
Retrieves OAuth2 provider data for the current user.
OAuth2ProviderIdGet 1 param → 200401404
PUT
/oauth2/provider/{oauth2ProviderId}
Updates an OAuth2 provider.
OAuth2ProviderIdPut 1 param body → 200401404
GET
/oauth2/provider/{oauth2ProviderId}/token
Retrieves a valid access token to the current user. A new token will be request if the current one is expired.
OAuth2ProviderIdTokenGet 1 param → 200401404
GET
/oauth2/token
Retrieves all OAuth2 tokens.
OAuth2TokenGet → 200401404
GET
/oauth2/token/client
Retrieves all OAuth2 client tokens for the current user.
OAuth2TokenClientGet → 200401404
DELETE
/oauth2/token/client/{oauth2ClientId}/user/{userName}
Deletes a OAuth2 client token.
OAuth2TokenClientIdUserDelete 2 params → 200401404
GET
/oauth2/token/client/{oauth2ClientId}/user/{userName}
Retrieves a OAuth2 client token.
OAuth2TokenClientIdUserGet 2 params → 200401404
PUT
/oauth2/token/client/{oauth2ClientId}/user/{userName}
Updates an OAuth2 client token.
OAuth2TokenClientIdUserPut 2 params → 200401404
GET
/oauth2/token/provider
Retrieves all OAuth2 provider tokens for the current user.
OAuth2TokenProviderGet → 200401404
DELETE
/oauth2/token/provider/{oauth2ProviderId}/user/{userName}
Delete an OAuth2 provider token.
OAuth2TokenProviderIdUserDelete 2 params → 200401404
GET
/oauth2/token/provider/{oauth2ProviderId}/user/{userName}
Gets an OAuth2 provider token.
OAuth2TokenProviderIdUserGet 2 params → 200401404
PUT
/oauth2/token/provider/{oauth2ProviderId}/user/{userName}
Updates an OAuth2 provider token.
OAuth2TokenProviderIdUserPut 2 params → 200401404
GET
/oauth2/token/search
Search tokens that match service name or user parameter.
OAuth2TokenSearchGet 1 param → 200401404
GET
/oauth2/token/{oAuth2TokenType}
Retrieves all OAuth2 tokens by OAuth2 token type. An OAuth2 token can be provided by Nuxeo or consumed.
OAuth2TokenTypeGet 1 param → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are oauth2ProviderDataList (19 properties), oauth2TokenDataList (19 properties), oauth2ClientDataList (19 properties), oauth2ProviderData (14 properties). Each schema is shown below with its type and property counts.

oauth2ProviderTokenData
object
1 property 1 required
oauth2ClientData
object
7 properties 4 required
oauth2ClientDataList
object
19 properties 2 required
oauth2TokenDataList
object
19 properties 2 required
oauth2ProviderDataList
object
19 properties 2 required
oauth2TokenData
object
8 properties 4 required
oauth2ProviderData
object
14 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-oauth2-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