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.policies_api.PoliciesApi(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_policy(body, **kwargs)[source]

Create access policy. 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_policy_with_http_info() method instead.

Parameters:

body (AccessPolicy) – The access policy configuration details. (required)

Returns:

The response data.

Return type:

AccessPolicy

create_access_policy_with_http_info(body, **kwargs)[source]

Create access policy. 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_policy() method instead.

Parameters:

body (AccessPolicy) – The access policy configuration details. (required)

Returns:

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

Return type:

tuple

get_access_policies(**kwargs)[source]

Get all access policies. 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_policies_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

list[AccessPolicy]

get_access_policies_with_http_info(**kwargs)[source]

Get all access policies. 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_policies() method instead.

Args:

Returns:

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

Return type:

tuple

get_access_policy(id, **kwargs)[source]

Get access policy. 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_policy_with_http_info() method instead.

Parameters:

id (str) – The access policy id. (required)

Returns:

The response data.

Return type:

AccessPolicy

get_access_policy_for_resource(action, resource, **kwargs)[source]

Get access policy for resource.

Gets an access policy for the specified action and resource

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

Parameters:

  • action (str) – The request action. (required)

  • resource (str) – The resource of the policy. (required)

Returns:

The response data.

Return type:

AccessPolicy

get_access_policy_for_resource_with_http_info(action, resource, **kwargs)[source]

Get access policy for resource.

Gets an access policy for the specified action and resource

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

Parameters:

  • action (str) – The request action. (required)

  • resource (str) – The resource of the policy. (required)

Returns:

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

Return type:

tuple

get_access_policy_with_http_info(id, **kwargs)[source]

Get access policy. 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_policy() method instead.

Parameters:

id (str) – The access policy id. (required)

Returns:

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

Return type:

tuple

get_resources(**kwargs)[source]

Get available resources.

Gets the available resources that support access/authorization policies

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

Args:

Returns:

The response data.

Return type:

list[Resource]

get_resources_with_http_info(**kwargs)[source]

Get available resources.

Gets the available resources that support access/authorization policies

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

Args:

Returns:

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

Return type:

tuple

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

Delete access policy. 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_access_policy_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 access policy 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:

AccessPolicy

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

Delete access policy. 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_access_policy() 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 access policy 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:

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

Return type:

tuple

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

Update access policy. 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_access_policy_with_http_info() method instead.

Parameters:

  • body (AccessPolicy) – The access policy configuration details. (required)

  • id (str) – The access policy id. (required)

Returns:

The response data.

Return type:

AccessPolicy

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

Update access policy. 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_access_policy() method instead.

Parameters:

  • body (AccessPolicy) – The access policy configuration details. (required)

  • id (str) – The access policy id. (required)

Returns:

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

Return type:

tuple