Apache NiFi Access API

openapi: 3.2.0
info:
  contact:
    email: dev@nifi.apache.org
    url: https://nifi.apache.org
  description: REST API definition for Apache NiFi web services
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Apache NiFi REST Access API
  version: 2.12.0
security:
- HTTPBearerJWT: []
- CookieSecureAuthorizationBearer: []
tags:
- name: Access
paths:
  /access/logout:
    delete:
      description: 'Note: This endpoint is subject to change as NiFi and it''s REST API evolve.'
      operationId: logOut
      responses:
        '200':
          description: User was logged out successfully.
        '401':
          description: Authentication token provided was empty or not in the correct JWT format.
        '500':
          description: Client failed to log out.
      summary: Performs a logout for other providers that have been issued a JWT
      tags:
      - Access
  /access/logout/complete:
    get:
      description: 'Note: This endpoint is subject to change as NiFi and it''s REST API evolve.'
      operationId: logOutComplete
      responses:
        '302':
          description: User was logged out successfully.
        '401':
          description: Authentication token provided was empty or not in the correct JWT format.
        '500':
          description: Client failed to log out.
      summary: Completes the logout sequence by removing the cached Logout Request and Cookie…
      tags:
      - Access
  /access/token:
    post:
      description: The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts.
      operationId: createAccessToken
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                password:
                  type: string
                username:
                  type: string
      responses:
        '201':
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
        '403':
          description: Client is not authorized to make this request.
        '409':
          description: The request was valid but NiFi was not in the appropriate state to process it.
        '500':
          description: Unable to create access token because an unexpected error occurred.
      security: []
      summary: Creates a token for accessing the REST API via username/password
      tags:
      - Access
components:
  securitySchemes:
    CookieSecureAuthorizationBearer:
      description: JSON Web Token authentication with session cookie
      in: cookie
      name: __Secure-Authorization-Bearer
      type: apiKey
    HTTPBearerJWT:
      bearerFormat: JWT
      description: HTTP Bearer authentication with JSON Web Token
      scheme: Bearer
      type: http
x-provenance:
  method: harvested
  publisher: Apache NiFi
  source: https://nifi.apache.org/nifi-docs/swagger.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)