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.tenants_api.TenantsApi(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_user(body, **kwargs)[source]

Creates a user.

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

Parameters:

body (UserEntity) – The user configuration details. (required)

Returns:

The response data.

Return type:

UserEntity

create_user_group(body, **kwargs)[source]

Creates a user group.

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

Parameters:

body (UserGroupEntity) – The user group configuration details. (required)

Returns:

The response data.

Return type:

UserGroupEntity

create_user_group_with_http_info(body, **kwargs)[source]

Creates a user group.

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

Parameters:

body (UserGroupEntity) – The user group configuration details. (required)

Returns:

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

Return type:

tuple

create_user_with_http_info(body, **kwargs)[source]

Creates a user.

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

Parameters:

body (UserEntity) – The user configuration details. (required)

Returns:

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

Return type:

tuple

get_user(id, **kwargs)[source]

Gets a user.

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

Parameters:

id (str) – The user id. (required)

Returns:

The response data.

Return type:

UserEntity

get_user_group(id, **kwargs)[source]

Gets a user group.

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

Parameters:

id (str) – The user group id. (required)

Returns:

The response data.

Return type:

UserGroupEntity

get_user_group_with_http_info(id, **kwargs)[source]

Gets a user group.

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

Parameters:

id (str) – The user group id. (required)

Returns:

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

Return type:

tuple

get_user_groups(**kwargs)[source]

Gets all user groups.

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

Args:

Returns:

The response data.

Return type:

UserGroupsEntity

get_user_groups_with_http_info(**kwargs)[source]

Gets all user groups.

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

Args:

Returns:

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

Return type:

tuple

get_user_with_http_info(id, **kwargs)[source]

Gets a user.

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

Parameters:

id (str) – The user id. (required)

Returns:

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

Return type:

tuple

get_users(**kwargs)[source]

Gets all users.

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

Args:

Returns:

The response data.

Return type:

UsersEntity

get_users_with_http_info(**kwargs)[source]

Gets all users.

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

Args:

Returns:

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

Return type:

tuple

remove_user(id, **kwargs)[source]

Deletes a user.

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

Parameters:

  • id (str) – The user id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (ClientIdParameter) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

The response data.

Return type:

UserEntity

remove_user_group(id, **kwargs)[source]

Deletes a user group.

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

Parameters:

  • id (str) – The user group id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (ClientIdParameter) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

The response data.

Return type:

UserGroupEntity

remove_user_group_with_http_info(id, **kwargs)[source]

Deletes a user group.

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

Parameters:

  • id (str) – The user group id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (ClientIdParameter) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

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

Return type:

tuple

remove_user_with_http_info(id, **kwargs)[source]

Deletes a user.

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

Parameters:

  • id (str) – The user id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (ClientIdParameter) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

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

Return type:

tuple

search_tenants(q, **kwargs)[source]

Searches for a tenant with the specified identity.

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

Parameters:

q (str) – Identity to search for. (required)

Returns:

The response data.

Return type:

TenantsEntity

search_tenants_with_http_info(q, **kwargs)[source]

Searches for a tenant with the specified identity.

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

Parameters:

q (str) – Identity to search for. (required)

Returns:

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

Return type:

tuple

update_user(body, id, **kwargs)[source]

Updates a user.

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

Parameters:

  • body (UserEntity) – The user configuration details. (required)

  • id (str) – The user id. (required)

Returns:

The response data.

Return type:

UserEntity

update_user_group(body, id, **kwargs)[source]

Updates a user group.

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

Parameters:

  • body (UserGroupEntity) – The user group configuration details. (required)

  • id (str) – The user group id. (required)

Returns:

The response data.

Return type:

UserGroupEntity

update_user_group_with_http_info(body, id, **kwargs)[source]

Updates a user group.

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

Parameters:

  • body (UserGroupEntity) – The user group configuration details. (required)

  • id (str) – The user group id. (required)

Returns:

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

Return type:

tuple

update_user_with_http_info(body, id, **kwargs)[source]

Updates a user.

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

Parameters:

  • body (UserEntity) – The user configuration details. (required)

  • id (str) – The user id. (required)

Returns:

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

Return type:

tuple