Apache NiFi Registry REST API

REST API definition for Apache NiFi Registry web services

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

class nipyapi.registry.apis.access_api.AccessApi(api_client=None)

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)

create_access_token_by_trying_all_providers(**kwargs)

Create token trying all providers.

Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. 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>’.

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_by_trying_all_providers_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

str

create_access_token_by_trying_all_providers_with_http_info(**kwargs)

Create token trying all providers.

Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. 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>’.

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_by_trying_all_providers() method instead.

Args:

Returns:

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

Return type:

tuple

create_access_token_using_basic_auth_credentials(**kwargs)

Create token using basic auth.

Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: ‘Authorization: Basic <credentials>’, where <credentials> is the base64 encoded value of ‘<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>’.

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_using_basic_auth_credentials_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

str

create_access_token_using_basic_auth_credentials_with_http_info(**kwargs)

Create token using basic auth.

Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: ‘Authorization: Basic <credentials>’, where <credentials> is the base64 encoded value of ‘<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>’.

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_using_basic_auth_credentials() method instead.

Args:

Returns:

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

Return type:

tuple

create_access_token_using_identity_provider_credentials(**kwargs)

Create token using identity provider.

Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by ‘GET /access/token/identity-provider/usage’. 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>’.

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_using_identity_provider_credentials_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

str

create_access_token_using_identity_provider_credentials_with_http_info(**kwargs)

Create token using identity provider.

Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by ‘GET /access/token/identity-provider/usage’. 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>’.

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_using_identity_provider_credentials() method instead.

Args:

Returns:

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

Return type:

tuple

create_access_token_using_kerberos_ticket(**kwargs)

Create token using kerberos.

Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). 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>’.

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_using_kerberos_ticket_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

str

create_access_token_using_kerberos_ticket_with_http_info(**kwargs)

Create token using kerberos.

Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). 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>’.

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_using_kerberos_ticket() method instead.

Args:

Returns:

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

Return type:

tuple

get_access_status(**kwargs)

Get access status.

Returns the current client’s authenticated identity and permissions to top-level resources

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 get_access_status_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

CurrentUser

get_access_status_with_http_info(**kwargs)

Get access status.

Returns the current client’s authenticated identity and permissions to top-level resources

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 get_access_status() method instead.

Args:

Returns:

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

Return type:

tuple

get_identity_provider_usage_instructions(**kwargs)

Get identity provider usage.

Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider

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 get_identity_provider_usage_instructions_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

str

get_identity_provider_usage_instructions_with_http_info(**kwargs)

Get identity provider usage.

Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider

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 get_identity_provider_usage_instructions() method instead.

Args:

Returns:

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

Return type:

tuple

logout(**kwargs)

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

NOTE: This endpoint is subject to change as NiFi Registry and its 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 logout_with_http_info() method instead.

Args:

Returns:

None

logout_complete(**kwargs)

Completes the logout sequence..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 logout_complete_with_http_info() method instead.

Args:

Returns:

None

logout_complete_with_http_info(**kwargs)

Completes the logout sequence..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 logout_complete() method instead.

Args:

Returns:

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

Return type:

tuple

logout_with_http_info(**kwargs)

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

NOTE: This endpoint is subject to change as NiFi Registry and its 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 logout() method instead.

Args:

Returns:

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

Return type:

tuple

oidc_callback(**kwargs)

Redirect/callback URI for processing the result of the OpenId Connect login sequence..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_callback_with_http_info() method instead.

Args:

Returns:

None

oidc_callback_with_http_info(**kwargs)

Redirect/callback URI for processing the result of the OpenId Connect login sequence..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_callback() method instead.

Args:

Returns:

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

Return type:

tuple

oidc_exchange(**kwargs)

Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_exchange_with_http_info() method instead.

Args:

Returns:

None

oidc_exchange_with_http_info(**kwargs)

Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_exchange() method instead.

Args:

Returns:

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

Return type:

tuple

oidc_logout(**kwargs)

Performs a logout in the OpenId Provider..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_logout_with_http_info() method instead.

Args:

Returns:

None

oidc_logout_callback(**kwargs)

Redirect/callback URI for processing the result of the OpenId Connect logout sequence..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_logout_callback_with_http_info() method instead.

Args:

Returns:

None

oidc_logout_callback_with_http_info(**kwargs)

Redirect/callback URI for processing the result of the OpenId Connect logout sequence..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_logout_callback() method instead.

Args:

Returns:

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

Return type:

tuple

oidc_logout_with_http_info(**kwargs)

Performs a logout in the OpenId Provider..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_logout() method instead.

Args:

Returns:

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

Return type:

tuple

oidc_request(**kwargs)

Initiates a request to authenticate through the configured OpenId Connect provider..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_request_with_http_info() method instead.

Args:

Returns:

None

oidc_request_with_http_info(**kwargs)

Initiates a request to authenticate through the configured OpenId Connect provider..

NOTE: This endpoint is subject to change as NiFi Registry and its 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 oidc_request() method instead.

Args:

Returns:

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

Return type:

tuple

test_identity_provider_recognizes_credentials_format(**kwargs)

Test identity provider.

Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by ‘GET /access/token/identity-provider/usage’.

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 test_identity_provider_recognizes_credentials_format_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

str

test_identity_provider_recognizes_credentials_format_with_http_info(**kwargs)

Test identity provider.

Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by ‘GET /access/token/identity-provider/usage’.

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 test_identity_provider_recognizes_credentials_format() method instead.

Args:

Returns:

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

Return type:

tuple