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.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]

Create user.

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

Parameters:

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

Returns:

The response data.

Return type:

User

create_user_group(body, **kwargs)[source]

Create user group.

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

Parameters:

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

Returns:

The response data.

Return type:

UserGroup

create_user_group_with_http_info(body, **kwargs)[source]

Create user group.

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

Parameters:

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

Returns:

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

Return type:

tuple

create_user_with_http_info(body, **kwargs)[source]

Create user.

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

Parameters:

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

Returns:

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

Return type:

tuple

get_user(id, **kwargs)[source]

Get user.

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

Parameters:

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

Returns:

The response data.

Return type:

User

get_user_group(id, **kwargs)[source]

Get user group.

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

Parameters:

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

Returns:

The response data.

Return type:

UserGroup

get_user_group_with_http_info(id, **kwargs)[source]

Get user group.

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

Parameters:

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

Returns:

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

Return type:

tuple

get_user_groups(**kwargs)[source]

Get user groups.

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

Args:

Returns:

The response data.

Return type:

list[UserGroup]

get_user_groups_with_http_info(**kwargs)[source]

Get user groups.

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

Args:

Returns:

(list[UserGroup], status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_user_with_http_info(id, **kwargs)[source]

Get user.

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

Parameters:

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

Returns:

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

Return type:

tuple

get_users(**kwargs)[source]

Get all users.

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

Args:

Returns:

The response data.

Return type:

list[User]

get_users_with_http_info(**kwargs)[source]

Get all users.

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

Args:

Returns:

(list[User], status_code, headers) - Response data with HTTP details.

Return type:

tuple

remove_user(version, id, **kwargs)[source]

Delete user.

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

Parameters:

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

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

  • 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.

Returns:

The response data.

Return type:

User

remove_user_group(version, id, **kwargs)[source]

Delete user group.

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

Parameters:

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

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

  • 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.

Returns:

The response data.

Return type:

UserGroup

remove_user_group_with_http_info(version, id, **kwargs)[source]

Delete user group.

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

Parameters:

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

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

  • 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.

Returns:

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

Return type:

tuple

remove_user_with_http_info(version, id, **kwargs)[source]

Delete user.

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

Parameters:

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

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

  • 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.

Returns:

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

Return type:

tuple

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

Update user.

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

Parameters:

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

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

Returns:

The response data.

Return type:

User

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

Update user group.

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

Parameters:

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

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

Returns:

The response data.

Return type:

UserGroup

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

Update user group.

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

Parameters:

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

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

Returns:

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

Return type:

tuple

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

Update user.

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

Parameters:

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

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

Returns:

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

Return type:

tuple