Apache NiFi REST API

REST API definition for Apache NiFi web services

OpenAPI spec version: 2.6.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.access_api.AccessApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

__init__(api_client=None)[source]
create_access_token(**kwargs)[source]

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. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding create_access_token_with_http_info() method instead.

Parameters:

  • password (str)

  • username (str)

Returns:

The response data.

Return type:

str

create_access_token_with_http_info(**kwargs)[source]

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. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding create_access_token() method instead.

Parameters:

  • password (str)

  • username (str)

Returns:

(str, status_code, headers) - Response data with HTTP details.

Return type:

tuple

log_out(**kwargs)[source]

Performs a logout for other providers that have been issued a JWT..

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding log_out_with_http_info() method instead.

Args:

Returns:

None

log_out_complete(**kwargs)[source]

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login..

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding log_out_complete_with_http_info() method instead.

Args:

Returns:

None

log_out_complete_with_http_info(**kwargs)[source]

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login..

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding log_out_complete() method instead.

Args:

Returns:

(None, status_code, headers) - Response data with HTTP details.

Return type:

tuple

log_out_with_http_info(**kwargs)[source]

Performs a logout for other providers that have been issued a JWT..

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding log_out() method instead.

Args:

Returns:

(None, status_code, headers) - Response data with HTTP details.

Return type:

tuple