Skip to content
nestjs-pipeline

Overview

users-api 0.4.2

Section titled “users-api 0.4.2”

The example application of nestjs-pipeline: users, roles and sessions behind the pipeline behaviors.

Every request names its tenant in x-tenant-schema. The users and roles routes accept the access token of POST /auths/login as a Bearer token, an API client’s x-api-id and x-api-key headers, or, with the Fastify adapter, the session cookie.

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/users
POST
/users
GET
/users/{id}
DELETE
/users/{id}
PATCH
/users/{id}
GET
/users/{id}/overview
GET
/roles
POST
/roles
GET
/roles/{id}
DELETE
/roles/{id}
PATCH
/roles/{id}
POST
/auths/login
POST
/auths/refresh
POST
/auths/logout

Authentication

Section titled “Authentication”

bearer

Section titled “bearer”

Security scheme type: http

Bearer format: JWT

api-id

Section titled “api-id”

Security scheme type: apiKey

Header parameter name: x-api-id

api-key

Section titled “api-key”

Security scheme type: apiKey

Header parameter name: x-api-key

Section titled “cookie”

Security scheme type: apiKey

Cookie parameter name: session