Skip to content

Latest commit

 

History

History
195 lines (113 loc) · 4.63 KB

AccessApi.md

File metadata and controls

195 lines (113 loc) · 4.63 KB

AccessApi

All URIs are relative to http://localhost/nifi-api

Method HTTP request Description
createAccessToken POST /access/token
createAccessTokenFromTicket POST /access/kerberos
createDownloadToken POST /access/download-token
createUiExtensionToken POST /access/ui-extension-token
getAccessStatus GET /access
getLoginConfig GET /access/config

createAccessToken

Creates a token for accessing the REST API via username/password

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. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.

Example

createAccessTokenFromTicket

Example

Parameters

Name Type Description Notes
username String [optional]
password String [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: text/plain

createAccessTokenFromTicket

Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation

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. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.

Example

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: text/plain
  • Accept: text/plain

createDownloadToken

Creates a single use access token for downloading FlowFile content.

The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.

Example

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: text/plain

createUiExtensionToken

Creates a single use access token for accessing a NiFi UI extension.

The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.

Example

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: text/plain

getAccessStatus

Gets the status the client's access

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

Parameters

This endpoint does not need any parameter.

Return type

AccessStatusEntity

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json

getLoginConfig

Retrieves the access configuration for this NiFi

Example

Parameters

This endpoint does not need any parameter.

Return type

AccessConfigurationEntity

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json