collibra-protect-100 1.0.0

Collibra Protect API

collibra-protect_100

This API allows you to manage groups.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import collibra_protect 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import collibra_protect

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import collibra_protect
from collibra_protect.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = collibra_protect.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_protect.CustomMaskingsApi(collibra_protect.ApiClient(configuration))
body = collibra_protect.AddCustomMaskingRequest() # AddCustomMaskingRequest | The new custom masking you want to add.

try:
    # Add a new custom masking
    api_response = api_instance.add_custom_masking(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomMaskingsApi->add_custom_masking: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_protect.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_protect.CustomMaskingsApi(collibra_protect.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The universally unique identifier (UUID) of the custom masking.

try:
    # Delete a custom masking
    api_instance.delete_custom_masking(id)
except ApiException as e:
    print("Exception when calling CustomMaskingsApi->delete_custom_masking: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_protect.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_protect.CustomMaskingsApi(collibra_protect.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The universally unique identifier (UUID) of the custom masking.

try:
    # Retrieve a custom masking
    api_response = api_instance.get_custom_masking(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomMaskingsApi->get_custom_masking: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_protect.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_protect.CustomMaskingsApi(collibra_protect.ApiClient(configuration))
limit = 25 # int | This is the maximum number of results that may be returned. Fewer may be returned than the value of <code>limit</code>.  Do not depend on the number of results being fewer than the <code>limit</code> value to indicate that your query reached the end of the list of data, use the absence of <code>after</code> (see Cursors) instead. For example, if you set <code>limit</code> to 10 and 9 results are returned, there may be more data available.  If not set, the default limit (limit = <code>25</code>) will be used. The maximum value for this parameter is <code>500</code>.  (optional) (default to 25)
after = 'after_example' # str | This is the cursor that points to the end of the page of data that has been returned. (optional)

try:
    # List custom maskings
    api_response = api_instance.list_custom_maskings(limit=limit, after=after)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomMaskingsApi->list_custom_maskings: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_protect.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_protect.CustomMaskingsApi(collibra_protect.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The universally unique identifier (UUID) of the custom masking.
body = collibra_protect.ChangeCustomMaskingRequest() # ChangeCustomMaskingRequest | The changes that need to be applied to the custom masking. (optional)

try:
    # Update a custom masking
    api_response = api_instance.patch_custom_masking(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomMaskingsApi->patch_custom_masking: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /rest/protect/v1

Class	Method	HTTP request	Description
CustomMaskingsApi	add_custom_masking	POST /customMaskings	Add a new custom masking
CustomMaskingsApi	delete_custom_masking	DELETE /customMaskings/{id}	Delete a custom masking
CustomMaskingsApi	get_custom_masking	GET /customMaskings/{id}	Retrieve a custom masking
CustomMaskingsApi	list_custom_maskings	GET /customMaskings	List custom maskings
CustomMaskingsApi	patch_custom_masking	PATCH /customMaskings/{id}	Update a custom masking
DataSourcesApi	add_data_source	POST /dataSources	Add a new data source
DataSourcesApi	delete_data_source	DELETE /dataSources/{id}	Delete a data source
DataSourcesApi	get_data_source	GET /dataSources/{id}	Retrieve a data source
DataSourcesApi	list_data_sources	GET /dataSources	List data sources
DataSourcesApi	patch_data_source	PATCH /dataSources/{id}	Update a data source
GroupsApi	add_group	POST /groups	Add a new group
GroupsApi	delete_group	DELETE /groups/{id}	Delete a group
GroupsApi	get_group	GET /groups/{id}	Retrieve a group
GroupsApi	list_groups	GET /groups	List groups
GroupsApi	patch_group	PATCH /groups/{id}	Update a group
PrescriptivePathsApi	add_prescriptive_path	POST /prescriptivePaths	Add a new prescriptive path
PrescriptivePathsApi	delete_prescriptive_path	DELETE /prescriptivePaths/{assetTypeId}	Delete a prescriptive path
PrescriptivePathsApi	get_prescriptive_path	GET /prescriptivePaths/{assetTypeId}	Retrieve a prescriptive path
PrescriptivePathsApi	list_asset_types	GET /prescriptivePaths/assetTypes	List asset types supported by Protect
PrescriptivePathsApi	list_prescriptive_paths	GET /prescriptivePaths	Lists all available prescriptive paths
PrescriptivePathsApi	patch_prescriptive_path	PATCH /prescriptivePaths/{assetTypeId}	Update a prescriptive path

Documentation For Models

• AddCustomMaskingRequest
• AddDataSourceRequest
• AddGroupRequest
• AddPrescriptivePathRequest
• AssetTypeIds
• ChangeCustomMaskingRequest
• ChangeDataSourceRequest
• ChangeGroupRequest
• ChangePrescriptivePathRequest
• Cursors
• CustomMasking
• DataSource
• DataSourceAlias
• EditableCustomMasking
• EditableDataSource
• EditableGroup
• EditablePrescriptivePath
• Group
• GroupMapping
• MaskingMapping
• PagedCustomMaskings
• PagedDataSources
• PagedGroups
• PrescriptivePath
• PrescriptivePathAssetType
• PrescriptivePathRelation
• PrescriptivePaths
• Provider
• ProviderMaskingMappings
• RelationTypeDirection
• StandardErrorResponse

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Author