User API Doc¶
IdentityServicesEngineAPI¶
The IdentityServicesEngineAPI
class creates “connection objects” for working with the Identity Services Engine APIs and hierarchically organizes the Identity Services Engine APIs and their endpoints underneath these connection objects.
IdentityServicesEngineAPI summary structure¶
v3.0.0 summary¶
IdentityServicesEngineAPI Class¶
- class IdentityServicesEngineAPI[source]¶
Identity Services Engine API wrapper.
Creates a ‘session’ for all API calls through a created IdentityServicesEngineAPI object. The ‘session’ handles authentication, provides the needed headers, and checks all responses for error conditions.
IdentityServicesEngineAPI wraps all of the individual Identity Services Engine APIs and represents them in a simple hierarchical structure.
- __init__(username=None, password=None, encoded_auth=None, uses_api_gateway=True, base_url='https://dcloud-dna-ise-rtp.cisco.com', ui_base_url=None, ers_base_url=None, mnt_base_url=None, px_grid_base_url=None, single_request_timeout=60, wait_on_rate_limit=True, verify=True, version='3.0.0', debug='False', object_factory=<function mydict_data_factory>, validator=<class 'ciscoisesdk.models.schema_validator.SchemaValidator'>)[source]¶
Create a new IdentityServicesEngineAPI object. An access token is required to interact with the Identity Services Engine APIs. This package supports two methods for you to pass the authorization token:
1. Provide a encoded_auth value (username:password encoded in base 64). This has priority over the following method
Provide username and password values.
This package supports two methods for you to set those values:
1. Provide the parameter. That is the encoded_auth or username and password parameters.
2. If an argument is not supplied, the package checks for its environment variable counterpart. That is the IDENTITY_SERVICES_ENGINE_ENCODED_AUTH, IDENTITY_SERVICES_ENGINE_USERNAME, IDENTITY_SERVICES_ENGINE_PASSWORD.
When not given enough parameters an AccessTokenError is raised.
- Parameters
uses_api_gateway (bool,basestring) – Controls whether we use the ISE’s API Gateway to make the request. Defaults to the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY (or IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY_STRING) environment variable or ciscoisesdk.config.DEFAULT_USES_API_GATEWAY if the environment variables are not set.
base_url (basestring) – The base URL to be prefixed to the individual API endpoint suffixes, used when uses_api_gateway is True. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable or ciscoisesdk.config.DEFAULT_BASE_URL if the environment variable is not set.
ui_base_url (basestring) – The UI base URL to be prefixed to the individual ISE UI API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
ers_base_url (basestring) – The ERS base URL to be prefixed to the individual ISE ERS API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
mnt_base_url (basestring) – The MNT base URL to be prefixed to the individual ISE MNT API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
px_grid_base_url (basestring) – The PxGrid base URL to be prefixed to the individual ISE PxGrid API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
username (basestring) – HTTP Basic Auth username.
password (basestring) – HTTP Basic Auth password.
encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.
single_request_timeout (int) – Timeout (in seconds) for RESTful HTTP requests. Defaults to the IDENTITY_SERVICES_ENGINE_SINGLE_REQUEST_TIMEOUT environment variable or ciscoisesdk.config.DEFAULT_SINGLE_REQUEST_TIMEOUT if the environment variable is not set.
wait_on_rate_limit (bool) – Enables or disables automatic rate-limit handling. Defaults to the IDENTITY_SERVICES_ENGINE_WAIT_ON_RATE_LIMIT environment variable or ciscoisesdk.config.DEFAULT_WAIT_ON_RATE_LIMIT if the environment variable is not set.
verify (bool,basestring) – Controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to the IDENTITY_SERVICES_ENGINE_VERIFY (or IDENTITY_SERVICES_ENGINE_VERIFY_STRING) environment variable or ciscoisesdk.config.DEFAULT_VERIFY if the environment variables are not set.
version (basestring) – Controls which version of IDENTITY_SERVICES_ENGINE to use. Defaults to the IDENTITY_SERVICES_ENGINE_VERSION environment variable or ciscoisesdk.config.DEFAULT_VERSION if the environment variable is not set.
debug (bool,basestring) – Controls whether to log information about Identity Services Engine APIs’ request and response process. Defaults to the IDENTITY_SERVICES_ENGINE_DEBUG environment variable or False if the environment variable is not set.
object_factory (callable) – The factory function to use to create Python objects from the returned Identity Services Engine JSON data objects.
validator (callable) – The factory class with function json_schema_validate(model:string) that returns an object with function validate(obj:dict) is used to validate Python objects sent in the request body.
- Returns
A new IdentityServicesEngineAPI object.
- Return type
- Raises
TypeError – If the parameter types are incorrect.
AccessTokenError – If an access token is not provided via the access_token argument or an environment variable.
VersionError – If the version is not provided via the version argument or an environment variable, or it is not a Identity Services Engine API supported version [‘3.0.0’].
- property uses_api_gateway¶
If the Identity Services Engine API uses an API Gateway.
- property session¶
The Identity Services Engine API session.
- property session_ui¶
The Identity Services Engine UI API session.
- property session_ers¶
The Identity Services Engine ERS API session.
- property session_mnt¶
The Identity Services Engine MNT API session.
- property session_px_grid¶
The Identity Services Engine PxGrid API session.
- property access_token¶
The access token used for API calls to the Identity Services Engine service.
- property version¶
The API version of Identity Services Engine.
- property verify¶
The verify (TLS Certificate) for the API endpoints.
- property base_url¶
The base URL prefixed to the individual API endpoint suffixes for ERS and Custom Caller operations.
- property single_request_timeout¶
Timeout (in seconds) for an single HTTP request.
- property wait_on_rate_limit¶
Automatic rate-limit handling enabled / disabled.
- property ui_base_url¶
The ui base URL prefixed to the individual API endpoint suffixes for UI operations.
- property ers_base_url¶
The ers base URL prefixed to the individual API endpoint suffixes for ERS operations.
- property mnt_base_url¶
The mnt base URL prefixed to the individual API endpoint suffixes for MNT operations.
- property px_grid_base_url¶
The px_grid base URL prefixed to the individual API endpoint suffixes for PxGrid operations
authentication¶
- class Authentication[source]¶
Identity Services Engine Authentication API.
Wraps the Identity Services Engine Authentication API and exposes the API as native Python methods that return native Python objects.
- property verify¶
The verify (TLS Certificate) for the API endpoints.
- property base_url¶
The base URL for the API endpoints.
- property single_request_timeout¶
Timeout in seconds for the API requests.
- authentication_api(username, password, encoded_auth=None)[source]¶
Exchange basic auth data for a Authorization Basic encoded value that can be used to invoke the APIs.
- Parameters
username (basestring) – HTTP Basic Auth username.
password (basestring) – HTTP Basic Auth password.
encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.
- Returns
An AccessToken object with the access token provided by the Identity Services Engine cloud.
- Return type
AccessToken
- Raises
TypeError – If the parameter types are incorrect.
custom_caller¶
- class CustomCaller[source]¶
Identity Services Engine CustomCaller.
Identity Services Engine CustomCaller allows API creation.
- call_api(method, resource_path, raise_exception=True, original_response=False, **kwargs)[source]¶
Handles the requests and response.
- Parameters
method (basestring) – type of request.
resource_path (basestring) – URL in the request object.
raise_exception (bool) – If True, http exceptions will be raised.
original_response (bool) – If True, MyDict (JSON response) is returned, else response object.
path_params (dict) (optional) – Find each path_params’ key in the resource_path and replace it with path_params’ value.
params (optional) – Dictionary or bytes to be sent in the query string for the Request.
data (optional) – Dictionary, bytes, or file-like object to send in the body of the Request.
json (optional) – json data to send in the body of the Request.
headers (optional) – Dictionary of HTTP Headers to send with the Request.
cookies (optional) – Dict or CookieJar object to send with the Request.
files (optional) – Dictionary of ‘name’: file-like-objects (or {‘name’: (‘filename’, fileobj)}) for multipart encoding upload.
auth (optional) – Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout (float, tuple) (optional) – How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.
allow_redirects (bool) (optional) – bool. Set to True if POST/PUT/DELETE redirect following is allowed.
proxies (optional) – Dictionary mapping protocol to the URL of the proxy.
verify (bool,string) (optional) – if True, the SSL cert will be verified. A CA_BUNDLE path can also be provided as a string.
stream (optional) – if False, the response content will be immediately downloaded.
cert (basestring, tuple) (optional) – if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair
- Returns
If original_response is True returns the original object response, else returns a JSON response with access to the object’s properties by using the dot notation or the bracket notation. Defaults to False.
- Return type
- Raises
TypeError – If the parameter types are incorrect.
HTTPError – If the Identity Services Engine cloud returns an error.
IdentityServicesEngineAPI v3.0.0¶
aci_bindings¶
- class AciBindings[source]¶
Identity Services Engine ACIBindings API (version: 3.0.0).
Wraps the Identity Services Engine ACIBindings API and exposes the API as native Python methods that return native Python objects.
- get_all_aci_bindings(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
Get all ACIBindings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter_by (basestring, list, set, tuple) – filterBy query parameter.
filter_value (basestring, list, set, tuple) – filterValue query parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_aci_bindings_generator(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
Get all ACIBindings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter_by (basestring, list, set, tuple) – filterBy query parameter.
filter_value (basestring, list, set, tuple) – filterValue query parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
aci_settings¶
- class AciSettings[source]¶
Identity Services Engine ACISettings API (version: 3.0.0).
Wraps the Identity Services Engine ACISettings API and exposes the API as native Python methods that return native Python objects.
- get_all_aci_settings(headers=None, **query_parameters)[source]¶
Get all ACISettings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_aci_settings_by_id(id, aci50=None, aci51=None, aciipaddress=None, acipassword=None, aciuser_name=None, admin_name=None, admin_password=None, all_sxp_domain=None, default_sgt_name=None, enable_aci=None, enable_data_plane=None, enable_elements_limit=None, ip_address_host_name=None, l3_route_network=None, max_num_iepg_from_aci=None, max_num_sgt_to_aci=None, specific_sxp_domain=None, specifix_sxp_domain_list=None, suffix_to_epg=None, suffix_to_sgt=None, tenant_name=None, untagged_packet_iepg_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update ACISettings by Id.
- Parameters
aci50 (boolean) – aci50, property of the request body.
aci51 (boolean) – aci51, property of the request body.
aciipaddress (string) – aciipaddress, property of the request body.
acipassword (string) – acipassword, property of the request body.
aciuser_name (string) – aciuserName, property of the request body.
admin_name (string) – adminName, property of the request body.
admin_password (string) – adminPassword, property of the request body.
all_sxp_domain (boolean) – allSxpDomain, property of the request body.
default_sgt_name (string) – defaultSgtName, property of the request body.
enable_aci (boolean) – enableAci, property of the request body.
enable_data_plane (boolean) – enableDataPlane, property of the request body.
enable_elements_limit (boolean) – enableElementsLimit, property of the request body.
id (basestring) – id, property of the request body.
ip_address_host_name (string) – ipAddressHostName, property of the request body.
l3_route_network (string) – l3RouteNetwork, property of the request body.
max_num_iepg_from_aci (integer) – maxNumIepgFromAci, property of the request body.
max_num_sgt_to_aci (integer) – maxNumSgtToAci, property of the request body.
specific_sxp_domain (boolean) – specificSxpDomain, property of the request body.
specifixSxpDomainList (list) – specifixSxpDomainList, property of the request body (list of strings).
suffix_to_epg (string) – suffixToEpg, property of the request body.
suffix_to_sgt (string) – suffixToSgt, property of the request body.
tenant_name (string) – tenantName, property of the request body.
untagged_packet_iepg_name (string) – untaggedPacketIepgName, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- test_aci_connectivity(headers=None, **query_parameters)[source]¶
Test ACI Connectivity.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
anc_endpoint¶
- class AncEndpoint[source]¶
Identity Services Engine ANCEndpoint API (version: 3.0.0).
Wraps the Identity Services Engine ANCEndpoint API and exposes the API as native Python methods that return native Python objects.
- get_all_anc_endpoint(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all ANCEndpoint.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_anc_endpoint_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all ANCEndpoint.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_anc_endpoint_by_id(id, headers=None, **query_parameters)[source]¶
Get ANCEndpoint by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- clear_anc_endpoint(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Clear ANC Endpoint.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- apply_anc_endpoint(additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Apply ANCEndpoint.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_anc_endpoint(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for ANC Endpoint.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_anc_endpoint(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for ANC Endpoint.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
anc_policy¶
- class AncPolicy[source]¶
Identity Services Engine ANCPolicy API (version: 3.0.0).
Wraps the Identity Services Engine ANCPolicy API and exposes the API as native Python methods that return native Python objects.
- get_all_anc_policy(headers=None, **query_parameters)[source]¶
Get all ANCPolicy.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_anc_policy(actions=None, filter=None, filter_type=None, name=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create ANCPolicy.
- Parameters
actions (list) – actions, property of the request body (list of strings).
name (string) – name, property of the request body.
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_anc_policy_by_id(id, headers=None, **query_parameters)[source]¶
Get ANCPolicy by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_anc_policy_by_id(id, actions=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update ANCPolicy.
- Parameters
actions (list) – actions, property of the request body (list of strings).
name (string) – name, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_anc_policy_by_id(id, headers=None, **query_parameters)[source]¶
Delete ANCPolicy by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_anc_policy_by_name(name, headers=None, **query_parameters)[source]¶
Get ANCPolicy by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_anc_policy(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for ANC Policy.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_anc_policy(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for ANC Policy.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
active_directory¶
- class ActiveDirectory[source]¶
Identity Services Engine ActiveDirectory API (version: 3.0.0).
Wraps the Identity Services Engine ActiveDirectory API and exposes the API as native Python methods that return native Python objects.
- get_all_active_directory(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Active Directory.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_active_directory_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Active Directory.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_active_directory(ad_attributes=None, ad_scopes_names=None, adgroups=None, advanced_settings=None, description=None, domain=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Attribute change: - < ISE 3.0 P2: enableDomainWhiteList - >= ISE 3.0 P2 enableDomainAllowedList.
- Parameters
ad_attributes (object) – adAttributes, property of the request body.
ad_scopes_names (string) – adScopesNames, property of the request body.
adgroups (object) – adgroups, property of the request body.
advanced_settings (object) – advancedSettings, property of the request body.
description (string) – description, property of the request body.
domain (string) – domain, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_active_directory_by_id(id, headers=None, **query_parameters)[source]¶
Get Active Directory by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_active_directory_by_id(id, headers=None, **query_parameters)[source]¶
Delete Active Directory by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_active_directory_by_name(name, headers=None, **query_parameters)[source]¶
Get Active Directory by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- join_domain_with_all_nodes(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Active Directory - join a domain with all nodes.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_groups_by_domain(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Active Directory get groups by domain.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- load_groups_from_domain(id, description=None, domain=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Reload domain groups configuration from Active Directory into ISE.
- Parameters
description (string) – description, property of the request body.
domain (string) – domain, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_user_groups(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Active Directory get user groups.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_trusted_domains(id, headers=None, **query_parameters)[source]¶
Active Directory get trusted domains.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- is_user_member_of_groups(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Active Directory is user a member of groups.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- join_domain(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Active Directory join a domain.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- leave_domain(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Active Directory leave a domain.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- leave_domain_with_all_nodes(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Leave a domain with all nodes.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
admin_user¶
- class AdminUser[source]¶
Identity Services Engine AdminUser API (version: 3.0.0).
Wraps the Identity Services Engine AdminUser API and exposes the API as native Python methods that return native Python objects.
- get_all_admin_users(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all AdminUser.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_admin_users_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all AdminUser.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_admin_user_by_id(id, headers=None, **query_parameters)[source]¶
Get AdminUser by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
allowed_protocols¶
- class AllowedProtocols[source]¶
Identity Services Engine AllowedProtocols API (version: 3.0.0).
Wraps the Identity Services Engine AllowedProtocols API and exposes the API as native Python methods that return native Python objects.
- get_all_allowed_protocols(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Allowed Protocols.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_allowed_protocols_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Allowed Protocols.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_allowed_protocol(allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Allowed Protocols.
- Parameters
allow_chap (boolean) – allowChap, property of the request body.
allow_eap_fast (boolean) – allowEapFast, property of the request body.
allow_eap_md5 (boolean) – allowEapMd5, property of the request body.
allow_eap_tls (boolean) – allowEapTls, property of the request body.
allow_eap_ttls (boolean) – allowEapTtls, property of the request body.
allow_leap (boolean) – allowLeap, property of the request body.
allow_ms_chap_v1 (boolean) – allowMsChapV1, property of the request body.
allow_ms_chap_v2 (boolean) – allowMsChapV2, property of the request body.
allow_pap_ascii (boolean) – allowPapAscii, property of the request body.
allow_peap (boolean) – allowPeap, property of the request body.
allow_preferred_eap_protocol (boolean) – allowPreferredEapProtocol, property of the request body.
allow_teap (boolean) – allowTeap, property of the request body.
allow_weak_ciphers_for_eap (boolean) – allowWeakCiphersForEap, property of the request body.
description (string) – description, property of the request body.
eap_fast (object) – eapFast, property of the request body.
eap_tls (object) – eapTls, property of the request body.
eap_tls_l_bit (boolean) – eapTlsLBit, property of the request body.
eap_ttls (object) – eapTtls, property of the request body.
name (string) – name, property of the request body.
peap (object) – peap, property of the request body.
preferred_eap_protocol (string) – preferredEapProtocol, property of the request body.
process_host_lookup (boolean) – processHostLookup, property of the request body.
require_message_auth (boolean) – requireMessageAuth, property of the request body.
teap (object) – teap, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_allowed_protocol_by_id(id, headers=None, **query_parameters)[source]¶
Get Allowed Protocols by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_allowed_protocol_by_id(id, allow_chap=None, allow_eap_fast=None, allow_eap_md5=None, allow_eap_tls=None, allow_eap_ttls=None, allow_leap=None, allow_ms_chap_v1=None, allow_ms_chap_v2=None, allow_pap_ascii=None, allow_peap=None, allow_preferred_eap_protocol=None, allow_teap=None, allow_weak_ciphers_for_eap=None, description=None, eap_fast=None, eap_tls=None, eap_tls_l_bit=None, eap_ttls=None, name=None, peap=None, preferred_eap_protocol=None, process_host_lookup=None, require_message_auth=None, teap=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Allowed Protocols by Id.
- Parameters
allow_chap (boolean) – allowChap, property of the request body.
allow_eap_fast (boolean) – allowEapFast, property of the request body.
allow_eap_md5 (boolean) – allowEapMd5, property of the request body.
allow_eap_tls (boolean) – allowEapTls, property of the request body.
allow_eap_ttls (boolean) – allowEapTtls, property of the request body.
allow_leap (boolean) – allowLeap, property of the request body.
allow_ms_chap_v1 (boolean) – allowMsChapV1, property of the request body.
allow_ms_chap_v2 (boolean) – allowMsChapV2, property of the request body.
allow_pap_ascii (boolean) – allowPapAscii, property of the request body.
allow_peap (boolean) – allowPeap, property of the request body.
allow_preferred_eap_protocol (boolean) – allowPreferredEapProtocol, property of the request body.
allow_teap (boolean) – allowTeap, property of the request body.
allow_weak_ciphers_for_eap (boolean) – allowWeakCiphersForEap, property of the request body.
description (string) – description, property of the request body.
eap_fast (object) – eapFast, property of the request body.
eap_tls (object) – eapTls, property of the request body.
eap_tls_l_bit (boolean) – eapTlsLBit, property of the request body.
eap_ttls (object) – eapTtls, property of the request body.
name (string) – name, property of the request body.
peap (object) – peap, property of the request body.
preferred_eap_protocol (string) – preferredEapProtocol, property of the request body.
process_host_lookup (boolean) – processHostLookup, property of the request body.
require_message_auth (boolean) – requireMessageAuth, property of the request body.
teap (object) – teap, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_allowed_protocol_by_id(id, headers=None, **query_parameters)[source]¶
Delete Allowed Protocols by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_allowed_protocol_by_name(name, headers=None, **query_parameters)[source]¶
Get Allowed Protocols by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
authorization_profile¶
- class AuthorizationProfile[source]¶
Identity Services Engine AuthorizationProfile API (version: 3.0.0).
Wraps the Identity Services Engine AuthorizationProfile API and exposes the API as native Python methods that return native Python objects.
- get_all_authorization_profiles(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all AuthorizationProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_authorization_profiles_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all AuthorizationProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_authorization_profile(access_type=None, acl=None, advanced_attributes=None, airespace_acl=None, airespace_i_pv6_acl=None, asa_vpn=None, authz_profile_type=None, auto_smart_port=None, avc_profile=None, dacl_name=None, description=None, easywired_session_candidate=None, id=None, interface_template=None, ipv6_acl_filter=None, ipv6_dacl_name=None, mac_sec_policy=None, name=None, neat=None, profile_name=None, reauth=None, service_template=None, track_movement=None, vlan=None, voice_domain_permission=None, web_auth=None, web_redirection=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create AuthorizationProfile.
- Parameters
access_type (string) – accessType, property of the request body.
acl (string) – acl, property of the request body.
advancedAttributes (list) – advancedAttributes, property of the request body (list of objects).
airespace_acl (string) – airespaceACL, property of the request body.
airespace_i_pv6_acl (string) – airespaceIPv6ACL, property of the request body.
asa_vpn (string) – asaVpn, property of the request body.
authz_profile_type (string) – authzProfileType, property of the request body.
auto_smart_port (string) – autoSmartPort, property of the request body.
avc_profile (string) – avcProfile, property of the request body.
dacl_name (string) – daclName, property of the request body.
description (string) – description, property of the request body.
easywired_session_candidate (boolean) – easywiredSessionCandidate, property of the request body.
id (string) – id, property of the request body.
interface_template (string) – interfaceTemplate, property of the request body.
ipv6_acl_filter (string) – ipv6ACLFilter, property of the request body.
ipv6_dacl_name (string) – ipv6DaclName, property of the request body.
mac_sec_policy (string) – macSecPolicy, property of the request body.
name (string) – name, property of the request body.
neat (boolean) – neat, property of the request body.
profile_name (string) – profileName, property of the request body.
reauth (object) – reauth, property of the request body.
service_template (boolean) – serviceTemplate, property of the request body.
track_movement (boolean) – trackMovement, property of the request body.
vlan (object) – vlan, property of the request body.
voice_domain_permission (boolean) – voiceDomainPermission, property of the request body.
web_auth (boolean) – webAuth, property of the request body.
web_redirection (object) – webRedirection, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_authorization_profile_by_id(id, headers=None, **query_parameters)[source]¶
Get AuthorizationProfile by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_authorization_profile_by_id(id, access_type=None, acl=None, advanced_attributes=None, airespace_acl=None, airespace_i_pv6_acl=None, asa_vpn=None, authz_profile_type=None, auto_smart_port=None, avc_profile=None, dacl_name=None, description=None, easywired_session_candidate=None, interface_template=None, ipv6_acl_filter=None, ipv6_dacl_name=None, mac_sec_policy=None, name=None, neat=None, profile_name=None, reauth=None, service_template=None, track_movement=None, vlan=None, voice_domain_permission=None, web_auth=None, web_redirection=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update AuthorizationProfile.
- Parameters
access_type (string) – accessType, property of the request body.
acl (string) – acl, property of the request body.
advancedAttributes (list) – advancedAttributes, property of the request body (list of objects).
airespace_acl (string) – airespaceACL, property of the request body.
airespace_i_pv6_acl (string) – airespaceIPv6ACL, property of the request body.
asa_vpn (string) – asaVpn, property of the request body.
authz_profile_type (string) – authzProfileType, property of the request body.
auto_smart_port (string) – autoSmartPort, property of the request body.
avc_profile (string) – avcProfile, property of the request body.
dacl_name (string) – daclName, property of the request body.
description (string) – description, property of the request body.
easywired_session_candidate (boolean) – easywiredSessionCandidate, property of the request body.
id (basestring) – id, property of the request body.
interface_template (string) – interfaceTemplate, property of the request body.
ipv6_acl_filter (string) – ipv6ACLFilter, property of the request body.
ipv6_dacl_name (string) – ipv6DaclName, property of the request body.
mac_sec_policy (string) – macSecPolicy, property of the request body.
name (string) – name, property of the request body.
neat (boolean) – neat, property of the request body.
profile_name (string) – profileName, property of the request body.
reauth (object) – reauth, property of the request body.
service_template (boolean) – serviceTemplate, property of the request body.
track_movement (boolean) – trackMovement, property of the request body.
vlan (object) – vlan, property of the request body.
voice_domain_permission (boolean) – voiceDomainPermission, property of the request body.
web_auth (boolean) – webAuth, property of the request body.
web_redirection (object) – webRedirection, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_authorization_profile_by_id(id, headers=None, **query_parameters)[source]¶
Delete AuthorizationProfile.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_authorization_profile_by_name(name, headers=None, **query_parameters)[source]¶
Get AuthorizationProfile by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
byod_portal¶
- class ByodPortal[source]¶
Identity Services Engine BYODPortal API (version: 3.0.0).
Wraps the Identity Services Engine BYODPortal API and exposes the API as native Python methods that return native Python objects.
- get_all_byod_portal(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all BYODPortal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_byod_portal_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all BYODPortal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_byod_portal(customizations=None, description=None, id=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create BYODPortal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_byod_portal_by_id(id, headers=None, **query_parameters)[source]¶
Get BYODPortal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_byod_portal_by_id(id, customizations=None, description=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update BYODPortal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_byod_portal_by_id(id, headers=None, **query_parameters)[source]¶
Delete BYODPortal.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
backup_and_restore¶
- class BackupAndRestore[source]¶
Identity Services Engine Backup And Restore API (version: 3.0.0).
Wraps the Identity Services Engine Backup And Restore API and exposes the API as native Python methods that return native Python objects.
- config_backup(backup_encryption_key=None, backup_name=None, repository_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Take the config DB backup now by providing the name of the backup,repository name and encryption key.
- Parameters
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria - Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
repository_name (string) – Name of the repository where the generated backup file will get copied., property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- restore_config_backup(backup_encryption_key=None, repository_name=None, restore_file=None, restore_include_adeos=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Restore a config DB backup by giving the name of the backup file, repository name and encryption key.
- Parameters
backup_encryption_key (string) – The encryption key which was provided at the time of taking backup., property of the request body.
repository_name (string) – Name of the configred repository where the backup file exists., property of the request body.
restore_file (string) – Name of the backup file to be restored on ISE node., property of the request body.
restore_include_adeos (string) – Determines whether the ADE-OS configure is restored., property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- cancel_backup(headers=None, **query_parameters)[source]¶
Cancel the running backup.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_last_config_backup_status(headers=None, **query_parameters)[source]¶
gives the last backup status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- schedule_config_backup(backup_description=None, backup_encryption_key=None, backup_name=None, end_date=None, frequency=None, repository_name=None, start_date=None, time=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Schedule the config backup.
- Parameters
backup_description (string) – Description of the backup., property of the request body.
backup_encryption_key (string) – The encyption key for the backed up file. Encryption key must satisfy the following criteria - Contains at least one uppercase letter [A-Z], Contains at least one lowercase letter [a-z], Contains at least one digit [0-9], Contain only [A-Z][a-z][0-9]_#, Has at least 8 characters, Has not more than 15 characters, Must not contain ‘CcIiSsCco’, Must not begin with, property of the request body.
backup_name (string) – The backup file will get saved with this name., property of the request body.
end_date (string) – End date of the scheduled backup job. Allowed format YYYY-MM-DD. End date is not required in case of ONE_TIME frequency., property of the request body.
frequency (string) – Frequency with which the backup will get scheduled in the ISE node. Allowed values - ONE_TIME, DAILY, WEEKLY, MONTHLY, property of the request body. Available values are ‘ONE_TIME’, ‘DAILY’, ‘WEEKLY’ and ‘MONTHLY’.
repository_name (string) – Name of the repository where the generated backup file will get copied., property of the request body.
start_date (string) – Start date for scheduling the backup job. Allowed format YYYY-MM-DD., property of the request body.
time (string) – Time at which backup job get scheduled. example- 12:00 AM, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
certificate_profile¶
- class CertificateProfile[source]¶
Identity Services Engine CertificateProfile API (version: 3.0.0).
Wraps the Identity Services Engine CertificateProfile API and exposes the API as native Python methods that return native Python objects.
- get_all_certificate_profile(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all CertificateProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_certificate_profile_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all CertificateProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_certificate_profile(allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, id=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create CertificateProfile.
- Parameters
allowed_as_user_name (boolean) – allowedAsUserName, property of the request body.
certificate_attribute_name (string) – certificateAttributeName, property of the request body.
description (string) – description, property of the request body.
external_identity_store_name (string) – externalIdentityStoreName, property of the request body.
id (string) – id, property of the request body.
match_mode (string) – matchMode, property of the request body.
name (string) – name, property of the request body.
username_from (string) – usernameFrom, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_certificate_profile_by_id(id, headers=None, **query_parameters)[source]¶
Get CertificateProfile by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_certificate_profile_by_id(id, allowed_as_user_name=None, certificate_attribute_name=None, description=None, external_identity_store_name=None, match_mode=None, name=None, username_from=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update CertificateProfile.
- Parameters
allowed_as_user_name (boolean) – allowedAsUserName, property of the request body.
certificate_attribute_name (string) – certificateAttributeName, property of the request body.
description (string) – description, property of the request body.
external_identity_store_name (string) – externalIdentityStoreName, property of the request body.
id (basestring) – id, property of the request body.
match_mode (string) – matchMode, property of the request body.
name (string) – name, property of the request body.
username_from (string) – usernameFrom, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_certificate_profile_by_name(name, headers=None, **query_parameters)[source]¶
Get CertificateProfile by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
certificate_template¶
- class CertificateTemplate[source]¶
Identity Services Engine CertificateTemplate API (version: 3.0.0).
Wraps the Identity Services Engine CertificateTemplate API and exposes the API as native Python methods that return native Python objects.
- get_all_certificate_template(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all CertificateTemplate.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_certificate_template_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all CertificateTemplate.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_certificate_template_by_id(id, headers=None, **query_parameters)[source]¶
Get CertificateTemplate by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_certificate_template_by_name(name, headers=None, **query_parameters)[source]¶
Get CertificateTemplate by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
certificates¶
- class Certificates[source]¶
Identity Services Engine Certificates API (version: 3.0.0).
Wraps the Identity Services Engine Certificates API and exposes the API as native Python methods that return native Python objects.
- import_trusted_certificate(allow_basic_constraint_cafalse=None, allow_out_of_date_cert=None, allow_sha1_certificates=None, data=None, description=None, name=None, trust_for_certificate_based_admin_auth=None, trust_for_cisco_services_auth=None, trust_for_client_auth=None, trust_for_ise_auth=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Purpose of the API is to add root certificate to the ISE truststore.
- Parameters
allow_basic_constraint_cafalse (boolean) – Allow Certificates with Basic Constraints CA Field as False (required), property of the request body.
allow_out_of_date_cert (boolean) – Allow out of date certificates (required), property of the request body.
allow_sha1_certificates (boolean) – Allow SHA1 based certificates (required), property of the request body.
data (string) – Certificate content (required), property of the request body.
description (string) – Description of the certificate, property of the request body.
name (string) – Name of the certificate, property of the request body.
trust_for_certificate_based_admin_auth (boolean) – Trust for Certificate based Admin authentication, property of the request body.
trust_for_cisco_services_auth (boolean) – Trust for authentication of Cisco Services, property of the request body.
trust_for_client_auth (boolean) – Trust for client authentication and Syslog, property of the request body.
trust_for_ise_auth (boolean) – Trust for authentication within ISE, property of the request body.
validate_certificate_extensions (boolean) – Validate trust certificate extension, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- import_system_certificate(admin=None, allow_extended_validity=None, allow_out_of_date_cert=None, allow_replacement_of_certificates=None, allow_replacement_of_portal_group_tag=None, allow_sha1_certificates=None, allow_wild_card_certificates=None, data=None, eap=None, ims=None, name=None, password=None, portal=None, portal_group_tag=None, private_key_data=None, pxgrid=None, radius=None, saml=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Purpose of the API is to import system certificate into ISE.
- Parameters
admin (boolean) – Use certificate to authenticate the ISE Admin Portal, property of the request body.
allow_extended_validity (boolean) – Allow import of certificates with validity greater than 398 days, property of the request body.
allow_out_of_date_cert (boolean) – Allow out of date certificates (required), property of the request body.
allow_replacement_of_certificates (boolean) – Allow Replacement of certificates (required), property of the request body.
allow_replacement_of_portal_group_tag (boolean) – Allow Replacement of Portal Group Tag (required), property of the request body.
allow_sha1_certificates (boolean) – Allow SHA1 based certificates (required), property of the request body.
allow_wild_card_certificates (boolean) – Allow Wildcard Certificates, property of the request body.
data (string) – Certificate Content (required), property of the request body.
eap (boolean) – Use certificate for EAP protocols that use SSL/TLS tunneling, property of the request body.
ims (boolean) – Use certificate for the ISE Messaging Service, property of the request body.
name (string) – Name of the certificate, property of the request body.
password (string) – Certificate Password (required)., property of the request body.
portal (boolean) – Use for portal, property of the request body.
portal_group_tag (string) – Set Group tag, property of the request body.
private_key_data (string) – Private Key data (required), property of the request body.
pxgrid (boolean) – Use certificate for the pxGrid Controller, property of the request body.
radius (boolean) – Use certificate for the RADSec server, property of the request body.
saml (boolean) – Use certificate for SAML Signing, property of the request body.
validate_certificate_extensions (boolean) – Validate Certificate Extensions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bind_csr(admin=None, allow_extended_validity=None, allow_out_of_date_cert=None, allow_replacement_of_certificates=None, allow_replacement_of_portal_group_tag=None, data=None, eap=None, host_name=None, id=None, ims=None, name=None, portal=None, portal_group_tag=None, pxgrid=None, radius=None, saml=None, validate_certificate_extensions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Purpose of the API is to Bind CA Signed Certificate.
- Parameters
admin (boolean) – Use certificate to authenticate the ISE Admin Portal, property of the request body.
allow_extended_validity (boolean) – Allow import of certificates with validity greater than 398 days, property of the request body.
allow_out_of_date_cert (boolean) – Allow out of date certificates (required), property of the request body.
allow_replacement_of_certificates (boolean) – Allow Replacement of certificates (required), property of the request body.
allow_replacement_of_portal_group_tag (boolean) – Allow Replacement of Portal Group Tag (required), property of the request body.
data (string) – Signed Certificate in escaped format, property of the request body.
eap (boolean) – Use certificate for EAP protocols that use SSL/TLS tunneling, property of the request body.
host_name (string) – Name of Host whose CSR ID has been provided, property of the request body.
id (string) – ID of the generated CSR, property of the request body.
ims (boolean) – Use certificate for the ISE Messaging Service, property of the request body.
name (string) – Friendly Name of the certificate, property of the request body.
portal (boolean) – Use for portal, property of the request body.
portal_group_tag (string) – Set Group tag, property of the request body.
pxgrid (boolean) – Use certificate for the pxGrid Controller, property of the request body.
radius (boolean) – Use certificate for the RADSec server, property of the request body.
saml (boolean) – Use certificate for SAML Signing, property of the request body.
validate_certificate_extensions (boolean) – Validate Certificate Extensions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- export_system_cert(certificate_id=None, export=None, id=None, password=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Purpose of the API is to export a system certificate given a certificate id.
- Parameters
certificate_id (string) – certificateID, property of the request body.
export (string) – export, property of the request body. Available values are ‘CERTIFICATE’ and ‘CERTIFICATE_WITH_PRIVATE_KEY’.
id (string) – id, property of the request body.
password (string) – password, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_trusted_certificates(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject issuedTo issuedBy validFrom Supported Date Format: yyyy-MM- dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT status Allowed values: enabled, disabled Supported Operators: EQ, NEQ .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_trusted_certificates_generator(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject issuedTo issuedBy validFrom Supported Date Format: yyyy-MM- dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT status Allowed values: enabled, disabled Supported Operators: EQ, NEQ .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_trusted_certificate_by_id(id, headers=None, **query_parameters)[source]¶
Purpose of this API is to get Trust Certificate By Id.
- Parameters
id (basestring) – id path parameter. The id of the trust certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_trusted_certificate(id, authenticate_before_crl_received=None, automatic_crl_update=None, automatic_crl_update_period=None, automatic_crl_update_units=None, crl_distribution_url=None, crl_download_failure_retries=None, crl_download_failure_retries_units=None, description=None, download_crl=None, enable_ocs_p_validation=None, enable_server_identity_check=None, ignore_crl_expiration=None, name=None, non_automatic_crl_update_period=None, non_automatic_crl_update_units=None, reject_if_no_status_from_ocs_p=None, reject_if_unreachable_from_ocs_p=None, selected_ocs_p_service=None, status=None, trust_for_certificate_based_admin_auth=None, trust_for_cisco_services_auth=None, trust_for_client_auth=None, trust_for_ise_auth=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Purpose of the API is to update trust certificate already present in ISE trust store.
- Parameters
authenticate_before_crl_received (boolean) – Switch to enable/disable CRL Verification if CRL is not Received, property of the request body.
automatic_crl_update (boolean) – Switch to enable/disable automatic CRL update, property of the request body.
automatic_crl_update_period (integer) – Automatic CRL update period, property of the request body.
automatic_crl_update_units (string) – Unit of time for automatic CRL update, property of the request body. Available values are ‘Minutes’, ‘Hours’, ‘Days’ and ‘Weeks’.
crl_distribution_url (string) – CRL Distribution URL, property of the request body.
crl_download_failure_retries (integer) – If CRL download fails, wait time before retry, property of the request body.
crl_download_failure_retries_units (string) – Unit of time before retry if CRL download fails, property of the request body. Available values are ‘Minutes’, ‘Hours’, ‘Days’ and ‘Weeks’.
description (string) – Description for trust certificate, property of the request body.
download_crl (boolean) – Switch to enable/disable download of CRL, property of the request body.
enable_ocs_p_validation (boolean) – Switch to enable/disable OCSP Validation, property of the request body.
enable_server_identity_check (boolean) – Switch to enable/disable verification if HTTPS or LDAP server certificate name fits the configured server URL, property of the request body.
ignore_crl_expiration (boolean) – Switch to enable/disable ignore CRL Expiration, property of the request body.
name (string) – Friendly name of the certificate, property of the request body.
non_automatic_crl_update_period (integer) – Non automatic CRL update period, property of the request body.
non_automatic_crl_update_units (string) – Unit of time of non automatic CRL update, property of the request body. Available values are ‘Minutes’, ‘Hours’, ‘Days’ and ‘Weeks’.
reject_if_no_status_from_ocs_p (boolean) – Switch to reject certificate if there is no status from OCSP, property of the request body.
reject_if_unreachable_from_ocs_p (boolean) – Switch to reject certificate if unreachable from OCSP, property of the request body.
selected_ocs_p_service (string) – Name of selected OCSP Service, property of the request body.
status (string) – status, property of the request body. Available values are ‘Enabled’ and ‘Disabled’.
trust_for_certificate_based_admin_auth (boolean) – Trust for Certificate based Admin authentication, property of the request body.
trust_for_cisco_services_auth (boolean) – Trust for authentication of Cisco Services, property of the request body.
trust_for_client_auth (boolean) – Trust for client authentication and Syslog, property of the request body.
trust_for_ise_auth (boolean) – Trust for authentication within ISE, property of the request body.
id (basestring) – id path parameter. The id of the trust certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_trusted_certificate_by_id(id, headers=None, **query_parameters)[source]¶
Purpose of the API is to delete Trusted Certificate by ID.
- Parameters
id (basestring) – id path parameter. The ID of the Trusted Certificate to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_system_certificates(host_name, filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName issuedTo issuedBy validFrom Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT .
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_system_certificates_generator(host_name, filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName issuedTo issuedBy validFrom Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT expirationDate Supported Date Format: yyyy-MM-dd HH:mm:ss Supported Operators: EQ, NEQ, GT and LT .
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_system_certificate_by_id(host_name, id, headers=None, **query_parameters)[source]¶
Purpose of this API is to get system certificate of a particular node by Id.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which system certificates should be returned.
id (basestring) – id path parameter. The id of the system certificate.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_system_certificate_by_id(host_name, id, headers=None, **query_parameters)[source]¶
Purpose of the API is to delete System Certificate by ID and hostname.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host from which the System Certificate needs to be deleted.
id (basestring) – id path parameter. The ID of the System Certificate to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_system_certificate(host_name, id, admin=None, allow_replacement_of_portal_group_tag=None, description=None, eap=None, expiration_ttl_period=None, expiration_ttl_units=None, ims=None, name=None, portal=None, portal_group_tag=None, pxgrid=None, radius=None, renew_self_signed_certificate=None, saml=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Purpose of the API is to update data for existing system certificate.
- Parameters
admin (boolean) – Use certificate to authenticate the ISE Admin Portal, property of the request body.
allow_replacement_of_portal_group_tag (boolean) – Allow Replacement of Portal Group Tag (required), property of the request body.
description (string) – Description of System Certificate, property of the request body.
eap (boolean) – Use certificate for EAP protocols that use SSL/TLS tunneling, property of the request body.
expiration_ttl_period (integer) – expirationTTLPeriod, property of the request body.
expiration_ttl_units (string) – expirationTTLUnits, property of the request body. Available values are ‘days’, ‘weeks’, ‘months’ and ‘years’.
ims (boolean) – Use certificate for the ISE Messaging Service, property of the request body.
name (string) – Name of the certificate, property of the request body.
portal (boolean) – Use for portal, property of the request body.
portal_group_tag (string) – Set Group tag, property of the request body.
pxgrid (boolean) – Use certificate for the pxGrid Controller, property of the request body.
radius (boolean) – Use certificate for the RADSec server, property of the request body.
renew_self_signed_certificate (boolean) – Renew Self Signed Certificate, property of the request body.
saml (boolean) – Use certificate for SAML Signing, property of the request body.
id (basestring) – id path parameter. The ID of the System Certificate to be updated.
host_name (basestring) – hostName path parameter. Name of Host whose certificate needs to be updated.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_csr(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject timeStamp Supported Date Format: yyyy-MM-dd HH:mm:ss.SSS Supported Operators: EQ, NEQ, GT and LT .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_csr_generator(filter=None, filter_type=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶
This API supports Filtering, Sorting and Pagination. Filtering and Sorting supported on below mentioned attributes: friendlyName subject timeStamp Supported Date Format: yyyy-MM-dd HH:mm:ss.SSS Supported Operators: EQ, NEQ, GT and LT .
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type - asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- generate_csr(allow_wild_card_cert=None, certificate_policies=None, digest_type=None, hostnames=None, key_length=None, key_type=None, portal_group_tag=None, san_dir=None, san_dns=None, san_ip=None, san_uri=None, subject_city=None, subject_common_name=None, subject_country=None, subject_org=None, subject_org_unit=None, subject_state=None, used_for=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Purpose of this API is to generate a Certificate Signing Request (CSR).
- Parameters
allow_wild_card_cert (boolean) – allowWildCardCert, property of the request body.
certificate_policies (string) – certificatePolicies, property of the request body.
digest_type (string) – digestType, property of the request body. Available values are ‘SHA-256’, ‘SHA-384’ and ‘SHA-512’.
hostnames (list) – hostnames, property of the request body (list of strings).
key_length (string) – keyLength, property of the request body. Available values are ‘512’, ‘1024’, ‘2048’ and ‘4096’.
key_type (string) – keyType, property of the request body. Available values are ‘RSA’ and ‘ECDSA’.
portal_group_tag (string) – portalGroupTag, property of the request body.
sanDNS (list) – sanDNS, property of the request body (list of strings).
sanDir (list) – sanDir, property of the request body (list of strings).
sanIP (list) – sanIP, property of the request body (list of strings).
sanURI (list) – sanURI, property of the request body (list of strings).
subject_city (string) – subjectCity, property of the request body.
subject_common_name (string) – subjectCommonName, property of the request body.
subject_country (string) – subjectCountry, property of the request body.
subject_org (string) – subjectOrg, property of the request body.
subject_org_unit (string) – subjectOrgUnit, property of the request body.
subject_state (string) – subjectState, property of the request body.
used_for (string) – usedFor, property of the request body. Available values are ‘MULTI-USE’, ‘ADMIN’, ‘EAP-AUTH’, ‘DTLS-AUTH’, ‘PORTAL’, ‘PXGRID’, ‘SAML’ and ‘IMS’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_csr_by_id(host_name, id, headers=None, **query_parameters)[source]¶
Purpose of the API is to get Certificate Signing Request(CSR) by ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which CSR’s should be returned.
id (basestring) – id path parameter. The ID of the Certificate Signing Request returned.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_csr_by_id(host_name, id, headers=None, **query_parameters)[source]¶
Purpose of the API is to delete Certificate Signing Request(CSR) by ID.
- Parameters
host_name (basestring) – hostName path parameter. Name of the host of which CSR’s should be deleted.
id (basestring) – id path parameter. The ID of the Certificate Signing Request to be deleted.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- generate_intermediate_ca_csr(headers=None, **query_parameters)[source]¶
Purpose of this API is to generate a intermediate CA Certificate Signing Request (CSR).
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- export_csr(hostname, id, headers=None, **query_parameters)[source]¶
The response of this API carries a CSR corresponding to the requested ID.
- Parameters
hostname (basestring) – hostname path parameter. The hostname to which the CSR belongs.
id (basestring) – id path parameter. The ID of the CSR to be exported.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- regenerate_ise_root_ca(remove_existing_ise_intermediate_csr=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
This API will initiate regeneration of ISE root CA certificate chain. Response contains id which can be used to track the status.
- Parameters
remove_existing_ise_intermediate_csr (boolean) – Setting this attribute to true will remove existing ISE Intermediate CSR, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- renew_certificate(cert_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
This API will initiate regeneration of certificates. Response contains id which can be used to track the status.
- Parameters
cert_type (string) – certType, property of the request body. Available values are ‘OCSP’ and ‘IMS’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- export_trusted_certificate(id, headers=None, **query_parameters)[source]¶
The response of this API carries a trusted certificate file mapped to the requested id.
- Parameters
id (basestring) – id path parameter. The ID of the Trusted Certificate to be exported.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
consumer¶
- class Consumer[source]¶
Identity Services Engine Consumer API (version: 3.0.0).
Wraps the Identity Services Engine Consumer API and exposes the API as native Python methods that return native Python objects.
- create_account(node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
🚧 AccountCreate.
- Parameters
node_name (string) – nodeName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- activate_account(description=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
🚧 AccountActivate.
- Parameters
description (string) – description, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- lookup_service(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
🚧 ServiceLookup.
- Parameters
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- access_secret(peer_node_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
🚧 AccessSecret.
- Parameters
peer_node_name (string) – peerNodeName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
deployment¶
- class Deployment[source]¶
Identity Services Engine Deployment API (version: 3.0.0).
Wraps the Identity Services Engine Deployment API and exposes the API as native Python methods that return native Python objects.
- get_all_deployment_info(timeout=None, headers=None, **query_parameters)[source]¶
Get all Deployment.
- Parameters
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_authentication_rules¶
- class DeviceAdministrationAuthenticationRules[source]¶
Identity Services Engine Device Administration - Authentication Rules API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Authentication Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_authentication_rules(policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Get authentication rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_authentication_rules(policy_id, identity_source_id=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Create authentication rule.
- Parameters
identity_source_id (string) – Identity source id from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_authentication_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Get rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_authentication_rule_by_id(id, policy_id, identity_source_id=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - - Update rule.
- Parameters
identity_source_id (string) – Identity source id from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_authentication_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Delete rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_authorization_exception_rules¶
- class DeviceAdministrationAuthorizationExceptionRules[source]¶
Identity Services Engine Device Administration - Authorization Exception Rules API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Authorization Exception Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_local_exception(policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Get local exception rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_local_exception(policy_id, commands=None, profile=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Create local authorization exception rule.
- Parameters
commands (list) – Command sets enforce the specified list of commands that can be executed by a device administrator, property of the request body (list of strings).
profile (string) – Device admin profiles control the initial login session of the device administrator, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_local_exception_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Get local exception rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_local_exception_by_id(id, policy_id, commands=None, profile=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update local exception rule.
- Parameters
commands (list) – Command sets enforce the specified list of commands that can be executed by a device administrator, property of the request body (list of strings).
profile (string) – Device admin profiles control the initial login session of the device administrator, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_local_exception_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Delete local exception rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_authorization_global_exception_rules¶
- class DeviceAdministrationAuthorizationGlobalExceptionRules[source]¶
Identity Services Engine Device Administration - Authorization Global Exception Rules API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Authorization Global Exception Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_policy_set_global_exception(headers=None, **query_parameters)[source]¶
Device Admin - Get global execption rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_policy_set_global_exception(commands=None, profile=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Create global exception authorization rule.
- Parameters
commands (list) – Command sets enforce the specified list of commands that can be executed by a device administrator, property of the request body (list of strings).
profile (string) – Device admin profiles control the initial login session of the device administrator, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_policy_set_global_exception_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Get global exception rule attribute.
- Parameters
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_policyset_global_exception_by_id(id, commands=None, profile=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update global exception authorization rule.
- Parameters
commands (list) – Command sets enforce the specified list of commands that can be executed by a device administrator, property of the request body (list of strings).
profile (string) – Device admin profiles control the initial login session of the device administrator, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_policyset_global_exception_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Delete global exception authorization rule.
- Parameters
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_authorization_rules¶
- class DeviceAdministrationAuthorizationRules[source]¶
Identity Services Engine Device Administration - Authorization Rules API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Authorization Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_authorization_rules(policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Get authorization rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_authorization_rule(policy_id, commands=None, profile=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Create authorization rule.
- Parameters
commands (list) – Command sets enforce the specified list of commands that can be executed by a device administrator, property of the request body (list of strings).
profile (string) – Device admin profiles control the initial login session of the device administrator, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_authorization_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Get authorization rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_authorization_rule_by_id(id, policy_id, commands=None, profile=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update authorization rule.
- Parameters
commands (list) – Command sets enforce the specified list of commands that can be executed by a device administrator, property of the request body (list of strings).
profile (string) – Device admin profiles control the initial login session of the device administrator, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_authorization_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Device Admin - Delete authorization rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_command_set¶
- class DeviceAdministrationCommandSet[source]¶
Identity Services Engine Device Administration - Command Set API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Command Set API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_command_sets(headers=None, **query_parameters)[source]¶
Device Admin - Return list of command sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_conditions¶
- class DeviceAdministrationConditions[source]¶
Identity Services Engine Device Administration - Conditions API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Conditions API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_conditions(headers=None, **query_parameters)[source]¶
Device Admin - Returns list of library conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_condition(attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Creates a library condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_device_admin_conditions_for_policy_set(headers=None, **query_parameters)[source]¶
Device Admin - Returns list of library conditions for policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_device_admin_conditions_for_authentication_rule(headers=None, **query_parameters)[source]¶
Device Admin - Returns list of library conditions for authentication rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_device_admin_conditions_for_authorization_rule(headers=None, **query_parameters)[source]¶
Device Admin - Returns list of library conditions for authorization rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_condition_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Returns a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_condition_by_id(id, attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update library condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_condition_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Delete a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_condition_by_name(name, headers=None, **query_parameters)[source]¶
Device Admin - Returns a library condition.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_condition_by_name(name, headers=None, **query_parameters)[source]¶
NDevice Admin - Delete a library condition using condition Name.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_condition_by_name(name, attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update library condition using condition name.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (basestring) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
name – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_dictionary_attributes_list¶
- class DeviceAdministrationDictionaryAttributesList[source]¶
Identity Services Engine Device Administration - Dictionary Attributes List API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Dictionary Attributes List API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_dictionaries_authentication(headers=None, **query_parameters)[source]¶
Network Access - Returns list of dictionary attributes for authentication.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_device_admin_dictionaries_authorization(headers=None, **query_parameters)[source]¶
Network Access - Returns list of dictionary attributes for authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_device_admin_dictionaries_policyset(headers=None, **query_parameters)[source]¶
Network Access - Returns list of dictionary attributes for policyset.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_identity_stores¶
- class DeviceAdministrationIdentityStores[source]¶
Identity Services Engine Device Administration - Identity Stores API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Identity Stores API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_identity_stores(headers=None, **query_parameters)[source]¶
Device Admin - Return list of identity stores for authentication.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_network_conditions¶
- class DeviceAdministrationNetworkConditions[source]¶
Identity Services Engine Device Administration - Network Conditions API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Network Conditions API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_network_conditions(headers=None, **query_parameters)[source]¶
Device Admin - Returns a list of network conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_network_condition(condition_type=None, conditions=None, description=None, id=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin- Creates network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘EndstationCondition’, ‘DeviceCondition’ and ‘DevicePortCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – NetworkCondition name, [Valid characters are alphanumerics, underscore, space], property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_network_condition_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_network_condition_by_id(id, condition_type=None, conditions=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘EndstationCondition’, ‘DeviceCondition’ and ‘DevicePortCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – NetworkCondition name, [Valid characters are alphanumerics, underscore, space], property of the request body.
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_network_condition_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Delete network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_policy_set¶
- class DeviceAdministrationPolicySet[source]¶
Identity Services Engine Device Administration - Policy Set API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Policy Set API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_policy_sets(headers=None, **query_parameters)[source]¶
Device Admin - List of policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_policy_set(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Create a new policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (string) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier - Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘enabled’, ‘disabled’ and ‘monitor’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_policy_set_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Get policy set attributes.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_policy_set_by_id(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update a policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (basestring) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier - Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘enabled’, ‘disabled’ and ‘monitor’.
id – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_policy_set_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Delete a policy set.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_profiles¶
- class DeviceAdministrationProfiles[source]¶
Identity Services Engine Device Administration - Profiles API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Profiles API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_profiles(headers=None, **query_parameters)[source]¶
Device Admin - Returns list of profiles.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_service_names¶
- class DeviceAdministrationServiceNames[source]¶
Identity Services Engine Device Administration - Service Names API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Service Names API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_service_names(headers=None, **query_parameters)[source]¶
Device Admin - Returns list of allowed protocols and server sequences.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
device_administration_time_date_conditions¶
- class DeviceAdministrationTimeDateConditions[source]¶
Identity Services Engine Device Administration - Time/Date Conditions API (version: 3.0.0).
Wraps the Identity Services Engine Device Administration - Time/Date Conditions API and exposes the API as native Python methods that return native Python objects.
- get_all_device_admin_time_conditions(headers=None, **query_parameters)[source]¶
Device Admin - Returns a list of time and date conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_device_admin_time_condition(attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Creates time/date condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_device_admin_time_condition_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_device_admin_time_condition_by_id(id, attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Device Admin - Update network condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_device_admin_time_condition_by_id(id, headers=None, **query_parameters)[source]¶
Device Admin - Delete Time/Date condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
downloadable_acl¶
- class DownloadableAcl[source]¶
Identity Services Engine DownloadableACL API (version: 3.0.0).
Wraps the Identity Services Engine DownloadableACL API and exposes the API as native Python methods that return native Python objects.
- get_all_downloadable_acl(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all DownloadableACL.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_downloadable_acl_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all DownloadableACL.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_downloadable_acl(dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create DownloadableACL.
- Parameters
dacl (string) – dacl, property of the request body.
dacl_type (string) – daclType, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_downloadable_acl_by_id(id, headers=None, **query_parameters)[source]¶
Get DownloadableACL by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_downloadable_acl_by_id(id, dacl=None, dacl_type=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update DownloadableACL.
- Parameters
dacl (string) – dacl, property of the request body.
dacl_type (string) – daclType, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_downloadable_acl_by_id(id, headers=None, **query_parameters)[source]¶
Delete DownloadableACL.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
egress_matrix_cell¶
- class EgressMatrixCell[source]¶
Identity Services Engine EgressMatrixCell API (version: 3.0.0).
Wraps the Identity Services Engine EgressMatrixCell API and exposes the API as native Python methods that return native Python objects.
- get_all_egress_matrix_cell(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all EgressMatrixCell.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_egress_matrix_cell_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all EgressMatrixCell.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_egress_matrix_cell(default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create EgressMatrixCell.
- Parameters
default_rule (string) – defaultRule, property of the request body.
description (string) – description, property of the request body.
destination_sgt_id (string) – destinationSgtId, property of the request body.
matrix_cell_status (string) – matrixCellStatus, property of the request body.
name (string) – name, property of the request body.
sgacls (list) – sgacls, property of the request body (list of strings).
source_sgt_id (string) – sourceSgtId, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_egress_matrix_cell_by_id(id, headers=None, **query_parameters)[source]¶
Get EgressMatrixCell by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_egress_matrix_cell_by_id(id, default_rule=None, description=None, destination_sgt_id=None, matrix_cell_status=None, name=None, sgacls=None, source_sgt_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update EgressMatrixCell.
- Parameters
default_rule (string) – defaultRule, property of the request body.
description (string) – description, property of the request body.
destination_sgt_id (string) – destinationSgtId, property of the request body.
matrix_cell_status (string) – matrixCellStatus, property of the request body.
name (string) – name, property of the request body.
sgacls (list) – sgacls, property of the request body (list of strings).
source_sgt_id (string) – sourceSgtId, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_egress_matrix_cell_by_id(id, headers=None, **query_parameters)[source]¶
Delete EgressMatrixCell.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- clear_all_matrix_cells(headers=None, **query_parameters)[source]¶
Clear all Egress Matrix Cells.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- set_all_cells_status(status, headers=None, **query_parameters)[source]¶
Set all Egress Cells Status.
- Parameters
status (basestring) – status path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- clone_matrix_cell(dst_sgt_id, id, src_sgt_id, headers=None, **query_parameters)[source]¶
Clone Egress Matrix Cell.
- Parameters
id (basestring) – id path parameter.
src_sgt_id (basestring) – srcSgtId path parameter.
dst_sgt_id (basestring) – dstSgtId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_egress_matrix_cell(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for Egress Matrix Cell.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_egress_matrix_cell(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for Egress Matrix Cell.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
endpoint¶
- class Endpoint[source]¶
Identity Services Engine Endpoint API (version: 3.0.0).
Wraps the Identity Services Engine Endpoint API and exposes the API as native Python methods that return native Python objects.
- get_all_endpoints(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Endpoint.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_endpoints_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Endpoint.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_endpoint(custom_attributes=None, description=None, group_id=None, id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
id (string) – id, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_endpoint_by_id(id, headers=None, **query_parameters)[source]¶
Get Endpoint by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_endpoint_by_id(id, custom_attributes=None, description=None, group_id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
id (basestring) – id, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_endpoint_by_id(id, headers=None, **query_parameters)[source]¶
Delete Endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_rejected_endpoints(headers=None, **query_parameters)[source]¶
Get all Rejected Endpoints.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_endpoint_by_name(name, headers=None, **query_parameters)[source]¶
Get Endpoint by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- register_endpoint(custom_attributes=None, description=None, group_id=None, id=None, identity_store=None, identity_store_id=None, mac=None, mdm_attributes=None, name=None, portal_user=None, profile_id=None, static_group_assignment=None, static_profile_assignment=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Register endpoint.
- Parameters
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
group_id (string) – groupId, property of the request body.
id (string) – id, property of the request body.
identity_store (string) – identityStore, property of the request body.
identity_store_id (string) – identityStoreId, property of the request body.
mac (string) – mac, property of the request body.
mdm_attributes (object) – mdmAttributes, property of the request body.
name (string) – name, property of the request body.
portal_user (string) – portalUser, property of the request body.
profile_id (string) – profileId, property of the request body.
static_group_assignment (boolean) – staticGroupAssignment, property of the request body.
static_profile_assignment (boolean) – staticProfileAssignment, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- deregister_endpoint(id, headers=None, **query_parameters)[source]¶
Deregister endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- release_rejected_endpoint(id, headers=None, **query_parameters)[source]¶
Release Rejected endpoint.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_endpoint(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for Endpoint.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_endpoint(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for Endpoint.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
endpoint_cert¶
- class EndpointCert[source]¶
Identity Services Engine EndpointCert API (version: 3.0.0).
Wraps the Identity Services Engine EndpointCert API and exposes the API as native Python methods that return native Python objects.
- create_endpoint_certificate(cert_template_name=None, certificate_request=None, format=None, password=None, dirpath=None, save_file=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create EndpointCert.
- Parameters
cert_template_name (string) – certTemplateName, property of the request body.
certificate_request (object) – certificateRequest, property of the request body.
format (string) – format, property of the request body.
password (string) – password, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
HTTP Response container. For more information check the urlib3 documentation
- Return type
urllib3.response.HTTPResponse
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
endpoint_group¶
- class EndpointGroup[source]¶
Identity Services Engine EndpointGroup API (version: 3.0.0).
Wraps the Identity Services Engine EndpointGroup API and exposes the API as native Python methods that return native Python objects.
- get_all_endpoint_groups(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all EndpointGroup.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_endpoint_groups_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all EndpointGroup.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_endpoint_group(description=None, id=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create EndpointGroup.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
system_defined (boolean) – systemDefined, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_endpoint_group_by_id(id, headers=None, **query_parameters)[source]¶
Get EndpointGroup by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_endpoint_group_by_id(id, description=None, name=None, system_defined=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update EndpointGroup.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
system_defined (boolean) – systemDefined, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_endpoint_group_by_id(id, headers=None, **query_parameters)[source]¶
Delete EndpointGroup.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_endpoint_group_by_name(name, headers=None, **query_parameters)[source]¶
Get EndpointGroup by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
external_radius_server¶
- class ExternalRadiusServer[source]¶
Identity Services Engine ExternalRADIUSServer API (version: 3.0.0).
Wraps the Identity Services Engine ExternalRADIUSServer API and exposes the API as native Python methods that return native Python objects.
- get_all_external_radius_server(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all External RADIUS Server.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_external_radius_server_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all External RADIUS Server.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_external_radius_server(accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, id=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create External RADIUS Server.
- Parameters
accounting_port (integer) – accountingPort, property of the request body.
authentication_port (integer) – authenticationPort, property of the request body.
authenticator_key (string) – authenticatorKey, property of the request body.
description (string) – description, property of the request body.
enable_key_wrap (boolean) – enableKeyWrap, property of the request body.
encryption_key (string) – encryptionKey, property of the request body.
host_ip (string) – hostIP, property of the request body.
id (string) – id, property of the request body.
key_input_format (string) – keyInputFormat, property of the request body.
name (string) – name, property of the request body.
proxy_timeout (integer) – proxyTimeout, property of the request body.
retries (integer) – retries, property of the request body.
shared_secret (string) – sharedSecret, property of the request body.
timeout (integer) – timeout, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_external_radius_server_by_id(id, headers=None, **query_parameters)[source]¶
Get External RADIUS Server by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_external_radius_server_by_id(id, accounting_port=None, authentication_port=None, authenticator_key=None, description=None, enable_key_wrap=None, encryption_key=None, host_ip=None, key_input_format=None, name=None, proxy_timeout=None, retries=None, shared_secret=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update External RADIUS Server.
- Parameters
accounting_port (integer) – accountingPort, property of the request body.
authentication_port (integer) – authenticationPort, property of the request body.
authenticator_key (string) – authenticatorKey, property of the request body.
description (string) – description, property of the request body.
enable_key_wrap (boolean) – enableKeyWrap, property of the request body.
encryption_key (string) – encryptionKey, property of the request body.
host_ip (string) – hostIP, property of the request body.
id (basestring) – id, property of the request body.
key_input_format (string) – keyInputFormat, property of the request body.
name (string) – name, property of the request body.
proxy_timeout (integer) – proxyTimeout, property of the request body.
retries (integer) – retries, property of the request body.
shared_secret (string) – sharedSecret, property of the request body.
timeout (integer) – timeout, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_external_radius_server_by_id(id, headers=None, **query_parameters)[source]¶
Delete External RADIUS Server.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_external_radius_server_by_name(name, headers=None, **query_parameters)[source]¶
Get External RADIUS Server by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
filter_policy¶
- class FilterPolicy[source]¶
Identity Services Engine FilterPolicy API (version: 3.0.0).
Wraps the Identity Services Engine FilterPolicy API and exposes the API as native Python methods that return native Python objects.
- get_filter_policy(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all FilterPolicy.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_filter_policy_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all FilterPolicy.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_filter_policy(domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create FilterPolicy.
- Parameters
domains (string) – domains, property of the request body.
sgt (string) – sgt, property of the request body.
subnet (string) – subnet, property of the request body.
vn (string) – vn, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_filter_policy_by_id(id, headers=None, **query_parameters)[source]¶
Get FilterPolicy by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_filter_policy_by_id(id, domains=None, sgt=None, subnet=None, vn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update FilterPolicy.
- Parameters
domains (string) – domains, property of the request body.
sgt (string) – sgt, property of the request body.
subnet (string) – subnet, property of the request body.
vn (string) – vn, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_filter_policy_by_id(id, headers=None, **query_parameters)[source]¶
Delete FilterPolicy.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
guest_location¶
- class GuestLocation[source]¶
Identity Services Engine GuestLocation API (version: 3.0.0).
Wraps the Identity Services Engine GuestLocation API and exposes the API as native Python methods that return native Python objects.
- get_all_guest_location(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest Location.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_guest_location_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest Location.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_guest_location_by_id(id, headers=None, **query_parameters)[source]¶
Get Guest Location by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
guest_smtp_notifications¶
- class GuestSmtpNotifications[source]¶
Identity Services Engine GuestSMTPNotifications API (version: 3.0.0).
Wraps the Identity Services Engine GuestSMTPNotifications API and exposes the API as native Python methods that return native Python objects.
- get_all_guest_smtp_notification_settings(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest SMTP Notifications Settings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_guest_smtp_notification_settings_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest SMTP Notifications Settings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_guest_smtp_notification_settings(connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Guest SMTP Notifications Settings.
- Parameters
connection_timeout (string) – connectionTimeout, property of the request body.
default_from_address (string) – defaultFromAddress, property of the request body.
notification_enabled (boolean) – notificationEnabled, property of the request body.
password (string) – password, property of the request body.
smtp_port (string) – smtpPort, property of the request body.
smtp_server (string) – smtpServer, property of the request body.
use_default_from_address (boolean) – useDefaultFromAddress, property of the request body.
use_password_authentication (boolean) – usePasswordAuthentication, property of the request body.
use_tlsor_ssl_encryption (boolean) – useTLSorSSLEncryption, property of the request body.
user_name (string) – userName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_guest_smtp_notification_settings_by_id(id, headers=None, **query_parameters)[source]¶
Get Guest SMTP Notifications Settings by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_smtp_notification_settings_by_id(id, connection_timeout=None, default_from_address=None, notification_enabled=None, password=None, smtp_port=None, smtp_server=None, use_default_from_address=None, use_password_authentication=None, use_tlsor_ssl_encryption=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Guest SMTP Notifications Settings.
- Parameters
connection_timeout (string) – connectionTimeout, property of the request body.
default_from_address (string) – defaultFromAddress, property of the request body.
notification_enabled (boolean) – notificationEnabled, property of the request body.
password (string) – password, property of the request body.
smtp_port (string) – smtpPort, property of the request body.
smtp_server (string) – smtpServer, property of the request body.
use_default_from_address (boolean) – useDefaultFromAddress, property of the request body.
use_password_authentication (boolean) – usePasswordAuthentication, property of the request body.
use_tlsor_ssl_encryption (boolean) – useTLSorSSLEncryption, property of the request body.
user_name (string) – userName, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
guest_ssid¶
- class GuestSsid[source]¶
Identity Services Engine GuestSSID API (version: 3.0.0).
Wraps the Identity Services Engine GuestSSID API and exposes the API as native Python methods that return native Python objects.
- get_all_guest_ssid(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest SSID.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_guest_ssid_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest SSID.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_guest_ssid(id=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Guest SSID.
- Parameters
id (string) – id, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_guest_ssid_by_id(id, headers=None, **query_parameters)[source]¶
Get Guest SSID by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_ssid_by_id(id, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Guest SSID.
- Parameters
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_guest_ssid_by_id(id, headers=None, **query_parameters)[source]¶
Delete Guest SSID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
guest_type¶
- class GuestType[source]¶
Identity Services Engine GuestType API (version: 3.0.0).
Wraps the Identity Services Engine GuestType API and exposes the API as native Python methods that return native Python objects.
- get_all_guest_type(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest Type.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_guest_type_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest Type.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_guest_type(access_time=None, description=None, expiration_notification=None, id=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Guest Type.
- Parameters
access_time (object) – accessTime, property of the request body.
description (string) – description, property of the request body.
expiration_notification (object) – expirationNotification, property of the request body.
id (string) – id, property of the request body.
login_options (object) – loginOptions, property of the request body.
name (string) – name, property of the request body.
sponsorGroups (list) – sponsorGroups, property of the request body (list of strings).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_guest_type_by_id(id, headers=None, **query_parameters)[source]¶
Get Guest Type by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guesttype_by_id(id, access_time=None, description=None, expiration_notification=None, login_options=None, name=None, sponsor_groups=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Guest Type.
- Parameters
access_time (object) – accessTime, property of the request body.
description (string) – description, property of the request body.
expiration_notification (object) – expirationNotification, property of the request body.
id (basestring) – id, property of the request body.
login_options (object) – loginOptions, property of the request body.
name (string) – name, property of the request body.
sponsorGroups (list) – sponsorGroups, property of the request body (list of strings).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_guest_type_by_id(id, headers=None, **query_parameters)[source]¶
Delete Guest Type by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_type_sms(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Guest Type SMS by Id.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_type_email(id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Guest Type Email by Id.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
guest_user¶
- class GuestUser[source]¶
Identity Services Engine GuestUser API (version: 3.0.0).
Wraps the Identity Services Engine GuestUser API and exposes the API as native Python methods that return native Python objects.
- get_all_guest_users(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest User (⚠ requires sponsor).
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_guest_users_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Guest User (⚠ requires sponsor).
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_guest_user(guest_access_info=None, guest_info=None, guest_type=None, portal_id=None, reason_for_visit=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Guest User.
- Parameters
guest_access_info (object) – guestAccessInfo, property of the request body.
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
portal_id (string) – portalId, property of the request body.
reason_for_visit (string) – reasonForVisit, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_guest_user_by_id(id, headers=None, **query_parameters)[source]¶
Get Guest User by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_user_by_id(id, guest_info=None, guest_type=None, portal_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Guest User.
- Parameters
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
id (basestring) – id, property of the request body.
portal_id (string) – portalId, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_guest_user_by_id(id, headers=None, **query_parameters)[source]¶
Delete Guest User.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_guest_user_by_name(name, headers=None, **query_parameters)[source]¶
Get Guest User by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_user_by_name(name, guest_info=None, guest_type=None, id=None, portal_id=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Guest User by name.
- Parameters
guest_info (object) – guestInfo, property of the request body.
guest_type (string) – guestType, property of the request body.
id (string) – id, property of the request body.
portal_id (string) – portalId, property of the request body.
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_guest_user_by_name(name, headers=None, **query_parameters)[source]¶
Delete Guest User by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- approve_guest_user_by_id(id, headers=None, **query_parameters)[source]¶
Approve Guest User by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- change_sponsor_password(portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Guest User change sponsor password by portal Id.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- deny_guest_user_by_id(id, headers=None, **query_parameters)[source]¶
Deny Guest User by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_user_email(id, portal_id, additional_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Guest User - email.
- Parameters
additionalData (list) – additionalData, property of the request body (list of objects).
id (basestring) – id path parameter.
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- reinstate_guest_user_by_id(id, headers=None, **query_parameters)[source]¶
Reinstate Guest User by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- reinstate_guest_user_by_name(name, headers=None, **query_parameters)[source]¶
Reinstate Guest User by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- reset_guest_user_password_by_id(id, headers=None, **query_parameters)[source]¶
Reset Guest User password by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_guest_user_sms(id, portal_id, headers=None, **query_parameters)[source]¶
Guest User - sms.
- Parameters
id (basestring) – id path parameter.
portal_id (basestring) – portalId path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- suspend_guest_user_by_id(id, headers=None, **query_parameters)[source]¶
Suspend Guest User by id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- suspend_guest_user_by_name(name, headers=None, **query_parameters)[source]¶
Suspend Guest User by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_guest_user(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for Guest User.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_guest_user(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for Guest User.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
hotspot_portal¶
- class HotspotPortal[source]¶
Identity Services Engine HotspotPortal API (version: 3.0.0).
Wraps the Identity Services Engine HotspotPortal API and exposes the API as native Python methods that return native Python objects.
- get_all_hotspot_portal(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Hotspot Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_hotspot_portal_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Hotspot Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_hotspot_portal(customizations=None, description=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Hotspot Portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_hotspot_portal_by_id(id, headers=None, **query_parameters)[source]¶
Get Hotspot Portal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_hotspot_portal_by_id(id, description=None, name=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Hotspot Portal by Id.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
settings (object) – settings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_hotspot_portal_by_id(id, headers=None, **query_parameters)[source]¶
Delete Hotspot Portal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
identity_group¶
- class IdentityGroup[source]¶
Identity Services Engine IdentityGroup API (version: 3.0.0).
Wraps the Identity Services Engine IdentityGroup API and exposes the API as native Python methods that return native Python objects.
- get_all_identity_groups(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Identity Group.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_identity_groups_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Identity Group.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_identity_group(description=None, id=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Identity Group.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_identity_group_by_id(id, headers=None, **query_parameters)[source]¶
Get Identity Group by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_identity_group_by_id(id, description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Identity Group by Id.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_identity_group_by_id(id, headers=None, **query_parameters)[source]¶
Delete IdentityGroup.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_identity_group_by_name(name, headers=None, **query_parameters)[source]¶
Get Identity Group by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
identity_store_sequence¶
- class IdentityStoreSequence[source]¶
Identity Services Engine IdentityStoreSequence API (version: 3.0.0).
Wraps the Identity Services Engine IdentityStoreSequence API and exposes the API as native Python methods that return native Python objects.
- get_all_identity_store_sequence(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Identity Store Sequence.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_identity_store_sequence_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Identity Store Sequence.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_identity_store_sequence(description=None, id=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Identity Store Sequence.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_identity_store_sequence_by_id(id, headers=None, **query_parameters)[source]¶
Get Identity Store Sequence by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_identity_store_sequence_by_id(id, description=None, name=None, parent=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Identity Store Sequence by Id.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
parent (string) – parent, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_identity_store_sequence_by_id(id, headers=None, **query_parameters)[source]¶
Delete Identity Store Sequence by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_identity_store_sequence_by_name(name, headers=None, **query_parameters)[source]¶
Get Identity Store Sequence by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
internal_user¶
- class InternalUser[source]¶
Identity Services Engine InternalUser API (version: 3.0.0).
Wraps the Identity Services Engine InternalUser API and exposes the API as native Python methods that return native Python objects.
- get_all_internal_user(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all InternalUser.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_internal_user_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all InternalUser.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_internal_user(change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, id=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create InternalUser.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – enabled, property of the request body.
expiry_date (string) – expiryDate, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
id (string) – id, property of the request body.
identity_groups (string) – identityGroups, property of the request body.
last_name (string) – lastName, property of the request body.
name (string) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – passwordIDStore, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- internaluser_by_id(id, headers=None, **query_parameters)[source]¶
Get InternalUser by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_internal_user_by_id(id, change_password=None, custom_attributes=None, description=None, email=None, enable_password=None, enabled=None, expiry_date=None, expiry_date_enabled=None, first_name=None, identity_groups=None, last_name=None, name=None, password=None, password_idstore=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update InternalUser.
- Parameters
change_password (boolean) – changePassword, property of the request body.
custom_attributes (object) – customAttributes, property of the request body.
description (string) – description, property of the request body.
email (string) – email, property of the request body.
enable_password (string) – enablePassword, property of the request body.
enabled (boolean) – enabled, property of the request body.
expiry_date (string) – expiryDate, property of the request body.
expiry_date_enabled (boolean) – expiryDateEnabled, property of the request body.
first_name (string) – firstName, property of the request body.
id (basestring) – id, property of the request body.
identity_groups (string) – identityGroups, property of the request body.
last_name (string) – lastName, property of the request body.
name (string) – name, property of the request body.
password (string) – password, property of the request body.
password_idstore (string) – passwordIDStore, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_internal_user_by_id(id, headers=None, **query_parameters)[source]¶
Delete InternalUser.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_internal_user_by_name(name, headers=None, **query_parameters)[source]¶
Get InternalUser by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_internal_user_by_name(name, password=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update InternalUser by name.
- Parameters
password (string) – password, property of the request body.
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_internal_user_by_name(name, headers=None, **query_parameters)[source]¶
Delete InternalUser by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
mdm¶
- class Mdm[source]¶
Identity Services Engine MDM API (version: 3.0.0).
Wraps the Identity Services Engine MDM API and exposes the API as native Python methods that return native Python objects.
- get_endpoints(headers=None, **query_parameters)[source]¶
🚧 getEndpoints.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_endpoint_by_mac_address(headers=None, **query_parameters)[source]¶
🚧 getEndpointByMacAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_endpoints_by_type(headers=None, **query_parameters)[source]¶
🚧 getEndpointsByType.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_endpoints_by_os_type(headers=None, **query_parameters)[source]¶
🚧 getEndpointsByOsType.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
misc¶
- class Misc[source]¶
Identity Services Engine Misc API (version: 3.0.0).
Wraps the Identity Services Engine Misc API and exposes the API as native Python methods that return native Python objects.
- get_active_count(headers=None, **query_parameters)[source]¶
ActiveCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_active_list(headers=None, **query_parameters)[source]¶
ActiveList.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_session_auth_list(headers=None, **query_parameters)[source]¶
Session/AuthList.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_posture_count(headers=None, **query_parameters)[source]¶
PostureCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_profiler_count(headers=None, **query_parameters)[source]¶
ProfilerCount.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sessions_by_mac(mac, headers=None, **query_parameters)[source]¶
Sessions by MAC.
- Parameters
mac (basestring) – mac path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sessions_by_username(username, headers=None, **query_parameters)[source]¶
Sessions by Username.
- Parameters
username (basestring) – username path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sessions_by_nas_ip(nas_ipv4, headers=None, **query_parameters)[source]¶
Sessions by NAS IP.
- Parameters
nas_ipv4 (basestring) – nas_ipv4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sessions_by_endpoint_ip(endpoint_ipv4, headers=None, **query_parameters)[source]¶
Sessions by Endpoint IP.
- Parameters
endpoint_ipv4 (basestring) – endpoint_ipv4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sessions_by_session_id(session_id, headers=None, **query_parameters)[source]¶
Sessions by SessionID.
- Parameters
session_id (basestring) – session_id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_all_sessions(headers=None, **query_parameters)[source]¶
Delete All Sessions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_mnt_version(headers=None, **query_parameters)[source]¶
MNT Version.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_failure_reasons(headers=None, **query_parameters)[source]¶
FailureReasons.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_authentication_status_by_mac(mac, rec_ord_s, sec_ond_s, headers=None, **query_parameters)[source]¶
AuthenticationStatus by MAC.
- Parameters
mac (basestring) – MAC path parameter.
sec_ond_s (basestring) – SECONDS path parameter.
rec_ord_s (basestring) – RECORDS path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- session_reauthentication_by_mac(end_poi_ntm_ac, psn_nam_e, rea_uth_typ_e, headers=None, **query_parameters)[source]¶
Session Reauthentication by MAC.
- Parameters
psn_nam_e (basestring) – PSN_NAME path parameter.
end_poi_ntm_ac (basestring) – ENDPOINT_MAC path parameter.
rea_uth_typ_e (basestring) – REAUTH_TYPE path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- session_disconnect(dis_con_nec_tty_pe, end_poi_nti_p, mac, nas_ipv4, psn_nam_e, headers=None, **query_parameters)[source]¶
Session Disconnect.
- Parameters
end_poi_nti_p (basestring) – ENDPOINT_IP path parameter.
psn_nam_e (basestring) – PSN_NAME path parameter.
mac (basestring) – MAC path parameter.
dis_con_nec_tty_pe (basestring) – DISCONNECT_TYPE path parameter.
nas_ipv4 (basestring) – NAS_IPV4 path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_account_status_by_mac(duration, mac, headers=None, **query_parameters)[source]¶
AccountStatus by MAC.
- Parameters
mac (basestring) – mac path parameter.
duration (basestring) – duration path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
my_device_portal¶
- class MyDevicePortal[source]¶
Identity Services Engine MyDevicePortal API (version: 3.0.0).
Wraps the Identity Services Engine MyDevicePortal API and exposes the API as native Python methods that return native Python objects.
- get_all_my_device_portal(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all MyDevicePortal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_my_device_portal_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all MyDevicePortal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_my_device_portal(customizations=None, description=None, id=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create MyDevicePortal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_my_device_portal_by_id(id, headers=None, **query_parameters)[source]¶
Get MyDevicePortal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_my_device_portal_by_id(id, customizations=None, description=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update MyDevicePortal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
native_supplicant_profile¶
- class NativeSupplicantProfile[source]¶
Identity Services Engine NativeSupplicantProfile API (version: 3.0.0).
Wraps the Identity Services Engine NativeSupplicantProfile API and exposes the API as native Python methods that return native Python objects.
- get_all_native_supplicant_profile(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all NativeSupplicantProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_native_supplicant_profile_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all NativeSupplicantProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_native_supplicant_profile_by_id(id, headers=None, **query_parameters)[source]¶
Get NativeSupplicantProfile by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_native_supplicant_profile_by_id(id, description=None, name=None, wireless_profiles=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update NativeSupplicantProfile.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
wirelessProfiles (list) – wirelessProfiles, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_native_supplicant_profile_by_id(id, headers=None, **query_parameters)[source]¶
Delete NativeSupplicantProfile.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_authentication_rules¶
- class NetworkAccessAuthenticationRules[source]¶
Identity Services Engine Network Access - Authentication Rules API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Authentication Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_authentication_rules(policy_id, headers=None, **query_parameters)[source]¶
Network Access - Get authentication rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_authentication_rule(policy_id, identity_source_id=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Create authentication rule.
- Parameters
identity_source_id (string) – Identity source id from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_authentication_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Network Access - Get rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_authentication_rule_by_id(id, policy_id, identity_source_id=None, if_auth_fail=None, if_process_fail=None, if_user_not_found=None, rule=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update rule.
- Parameters
identity_source_id (string) – Identity source id from the identity stores, property of the request body.
if_auth_fail (string) – Action to perform when authentication fails such as Bad credentials, disabled user and so on, property of the request body.
if_process_fail (string) – Action to perform when ISE is uanble to access the identity database, property of the request body.
if_user_not_found (string) – Action to perform when user is not found in any of identity stores, property of the request body.
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_authentication_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Network Access - Delete rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_authorization_exception_rules¶
- class NetworkAccessAuthorizationExceptionRules[source]¶
Identity Services Engine Network Access - Authorization Exception Rules API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Authorization Exception Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_local_exception_rules(policy_id, headers=None, **query_parameters)[source]¶
Network Access - Get local exception rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_local_exception_rule(policy_id, profile=None, rule=None, security_group=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Create local authorization exception rule.
- Parameters
profile (list) – The authorization profile/s, property of the request body (list of strings).
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
security_group (string) – Security group used in authorization policies, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_local_exception_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Network Access - Get local exception rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_local_exception_rule_by_id(id, policy_id, profile=None, rule=None, security_group=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update local exception rule.
- Parameters
profile (list) – The authorization profile/s, property of the request body (list of strings).
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
security_group (string) – Security group used in authorization policies, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_local_exception_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Network Access - Delete local exception rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_authorization_global_exception_rules¶
- class NetworkAccessAuthorizationGlobalExceptionRules[source]¶
Identity Services Engine Network Access - Authorization Global Exception Rules API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Authorization Global Exception Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_global_exception_rules(headers=None, **query_parameters)[source]¶
Network Access - Get global execption rules.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_global_exception_rule(profile=None, rule=None, security_group=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Create global exception authorization rule.
- Parameters
profile (list) – The authorization profile/s, property of the request body (list of strings).
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
security_group (string) – Security group used in authorization policies, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_global_exception_rule_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Get global exception rule attributes.
- Parameters
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_global_exception_rule_by_id(id, profile=None, rule=None, security_group=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update global exception authorization rule.
- Parameters
profile (list) – The authorization profile/s, property of the request body (list of strings).
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
security_group (string) – Security group used in authorization policies, property of the request body.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_global_exception_rule_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Delete global exception authorization rule.
- Parameters
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_authorization_rules¶
- class NetworkAccessAuthorizationRules[source]¶
Identity Services Engine Network Access - Authorization Rules API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Authorization Rules API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_authorization_rules(policy_id, headers=None, **query_parameters)[source]¶
Network Access - Get authorization rules.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_authorization_rule(policy_id, profile=None, rule=None, security_group=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Create authorization rule.
- Parameters
profile (list) – The authorization profile/s, property of the request body (list of strings).
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
security_group (string) – Security group used in authorization policies, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_authorization_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Network Access - Get authorization rule attributes.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_authorization_rule_by_id(id, policy_id, profile=None, rule=None, security_group=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update authorization rule.
- Parameters
profile (list) – The authorization profile/s, property of the request body (list of strings).
rule (object) – Common attributes in rule authentication/authorization, property of the request body.
security_group (string) – Security group used in authorization policies, property of the request body.
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_authorization_rule_by_id(id, policy_id, headers=None, **query_parameters)[source]¶
Network Access - Delete authorization rule.
- Parameters
policy_id (basestring) – policyId path parameter. Policy id.
id (basestring) – id path parameter. Rule id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_conditions¶
- class NetworkAccessConditions[source]¶
Identity Services Engine Network Access - Conditions API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Conditions API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_conditions(headers=None, **query_parameters)[source]¶
Network Access - Returns list of library conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_condition(attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Creates a library condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_network_access_conditions_for_policy_set(headers=None, **query_parameters)[source]¶
Network Access - Returns list of library conditions for PolicySet scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_network_access_conditions_for_authentication_rules(headers=None, **query_parameters)[source]¶
Network Access - Returns list of library conditions for Authentication rules scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_network_access_conditions_for_authorization_rule(headers=None, **query_parameters)[source]¶
Network Access - Returns list of library conditions for Authorization rules scope.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_condition_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Returns a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_condition_by_id(id, attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update library condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_condition_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Delete a library condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_condition_by_name(name, headers=None, **query_parameters)[source]¶
Network Access - Returns a library condition.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_condition_by_name(name, headers=None, **query_parameters)[source]¶
Network Access - Delete a library condition using condition Name.
- Parameters
name (basestring) – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_condition_by_name(name, attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update library condition using condition name.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (basestring) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
name – name path parameter. Condition name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_dictionary¶
- class NetworkAccessDictionary[source]¶
Identity Services Engine Network Access - Dictionary API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Dictionary API and exposes the API as native Python methods that return native Python objects.
- create_network_access_dictionaries(description=None, dictionary_attr_type=None, id=None, name=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Create a new Dictionary.
- Parameters
description (string) – The description of the Dictionary, property of the request body.
dictionary_attr_type (string) – The dictionary attribute type, property of the request body. Available values are ‘ENTITY_ATTR’, ‘MSG_ATTR’ and ‘PIP_ATTR’.
id (string) – Identifier for the dictionary, property of the request body.
name (string) – The dictionary name, property of the request body.
version (string) – The dictionary version, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_dictionary_by_name(name, headers=None, **query_parameters)[source]¶
GET a dictionary by name.
- Parameters
name (basestring) – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_dictionaries_by_name(name, description=None, dictionary_attr_type=None, id=None, version=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update a Dictionary.
- Parameters
description (string) – The description of the Dictionary, property of the request body.
dictionary_attr_type (string) – The dictionary attribute type, property of the request body. Available values are ‘ENTITY_ATTR’, ‘MSG_ATTR’ and ‘PIP_ATTR’.
id (string) – Identifier for the dictionary, property of the request body.
name (basestring) – The dictionary name, property of the request body.
version (string) – The dictionary version, property of the request body.
name – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_dictionaries_by_name(name, headers=None, **query_parameters)[source]¶
Network Access - Delete a Dictionary.
- Parameters
name (basestring) – name path parameter. the dictionary name.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_dictionary_attribute¶
- class NetworkAccessDictionaryAttribute[source]¶
Identity Services Engine Network Access - Dictionary Attribute API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Dictionary Attribute API and exposes the API as native Python methods that return native Python objects.
- create_network_access_dictionary_attribute_for_dictionary(dictionary_name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create a new Dictionary Attribute for an existing Dictionary.
- Parameters
allowedValues (list) – all of the allowed values for the dictionary attribute, property of the request body (list of objects).
data_type (string) – the data type for the dictionary attribute, property of the request body. Available values are ‘BOOLEAN’, ‘DATE’, ‘FLOAT’, ‘INT’, ‘IP’, ‘IPV4’, ‘IPV6’, ‘IPV6INTERFACE’, ‘IPV6PREFIX’, ‘LONG’, ‘OCTET_STRING’, ‘STRING’, ‘UNIT32’ and ‘UINT64’.
description (string) – The description of the Dictionary attribute, property of the request body.
dictionary_name (basestring) – the name of the dictionary which the dictionary attribute belongs to, property of the request body.
direction_type (string) – the direction for the useage of the dictionary attribute, property of the request body. Available values are ‘IN’, ‘OUT’, ‘NONE’ and ‘BOTH’.
id (string) – Identifier for the dictionary attribute, property of the request body.
internal_name (string) – the internal name of the dictionary attribute, property of the request body.
name (string) – The dictionary attribute’s name, property of the request body.
dictionary_name – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_dictionary_attribute_by_name(dictionary_name, name, headers=None, **query_parameters)[source]¶
Get a Dictionary Attribute.
- Parameters
name (basestring) – name path parameter. the dictionary attribute name.
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_dictionary_attribute_by_name(dictionary_name, name, allowed_values=None, data_type=None, description=None, direction_type=None, id=None, internal_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update a Dictionary Attribute.
- Parameters
allowedValues (list) – all of the allowed values for the dictionary attribute, property of the request body (list of objects).
data_type (string) – the data type for the dictionary attribute, property of the request body. Available values are ‘BOOLEAN’, ‘DATE’, ‘FLOAT’, ‘INT’, ‘IP’, ‘IPV4’, ‘IPV6’, ‘IPV6INTERFACE’, ‘IPV6PREFIX’, ‘LONG’, ‘OCTET_STRING’, ‘STRING’, ‘UNIT32’ and ‘UINT64’.
description (string) – The description of the Dictionary attribute, property of the request body.
dictionary_name (basestring) – the name of the dictionary which the dictionary attribute belongs to, property of the request body.
direction_type (string) – the direction for the useage of the dictionary attribute, property of the request body. Available values are ‘IN’, ‘OUT’, ‘NONE’ and ‘BOTH’.
id (string) – Identifier for the dictionary attribute, property of the request body.
internal_name (string) – the internal name of the dictionary attribute, property of the request body.
name (basestring) – The dictionary attribute’s name, property of the request body.
name – name path parameter. the dictionary attribute name.
dictionary_name – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_dictionary_attribute_by_name(dictionary_name, name, headers=None, **query_parameters)[source]¶
Delete a Dictionary Attribute.
- Parameters
name (basestring) – name path parameter. the dictionary attribute name.
dictionary_name (basestring) – dictionaryName path parameter. the name of the dictionary the dictionary attribute belongs to.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_dictionary_attributes_list¶
- class NetworkAccessDictionaryAttributesList[source]¶
Identity Services Engine Network Access - Dictionary Attributes List API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Dictionary Attributes List API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_dictionaries_authentication(headers=None, **query_parameters)[source]¶
Network Access - Returns list of dictionary attributes for authentication.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_network_access_dictionaries_authorization(headers=None, **query_parameters)[source]¶
Network Access - Returns list of dictionary attributes for authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_network_access_dictionaries_policyset(headers=None, **query_parameters)[source]¶
Network Access - Returns list of dictionary attributes for policyset.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_identity_stores¶
- class NetworkAccessIdentityStores[source]¶
Identity Services Engine Network Access - Identity Stores API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Identity Stores API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_identity_stores(headers=None, **query_parameters)[source]¶
Network Access - Return list of identity stores for authentication policy definition.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_network_conditions¶
- class NetworkAccessNetworkConditions[source]¶
Identity Services Engine Network Access - Network Conditions API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Network Conditions API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_network_conditions(headers=None, **query_parameters)[source]¶
Network Access - Returns a list of network conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_network_condition(condition_type=None, conditions=None, description=None, id=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Creates network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘EndstationCondition’, ‘DeviceCondition’ and ‘DevicePortCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – NetworkCondition name, [Valid characters are alphanumerics, underscore, space], property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_network_condition_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_network_condition_by_id(id, condition_type=None, conditions=None, description=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update network condition.
- Parameters
condition_type (string) – This field determines the content of the conditions field, property of the request body. Available values are ‘EndstationCondition’, ‘DeviceCondition’ and ‘DevicePortCondition’.
conditions (list) – conditions, property of the request body (list of objects).
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – NetworkCondition name, [Valid characters are alphanumerics, underscore, space], property of the request body.
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_network_condition_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Delete network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_policy_set¶
- class NetworkAccessPolicySet[source]¶
Identity Services Engine Network Access - Policy Set API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Policy Set API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_policy_sets(headers=None, **query_parameters)[source]¶
Get all network access policy sets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_policy_set(condition=None, default=None, description=None, hit_counts=None, id=None, is_proxy=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Create a new policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (string) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier - Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘enabled’, ‘disabled’ and ‘monitor’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_policy_set_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Get policy set attributes.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_policy_set_by_id(id, condition=None, default=None, description=None, hit_counts=None, is_proxy=None, name=None, rank=None, service_name=None, state=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update a policy set.
- Parameters
condition (object) – condition, property of the request body.
default (boolean) – Flag which indicates if this policy set is the default one, property of the request body.
description (string) – The description for the policy set, property of the request body.
hit_counts (integer) – The amount of times the policy was matched, property of the request body.
id (basestring) – Identifier for the policy set, property of the request body.
is_proxy (boolean) – Flag which indicates if the policy set service is of type ‘Proxy Sequence’ or ‘Allowed Protocols’, property of the request body.
name (string) – Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses], property of the request body.
rank (integer) – The rank(priority) in relation to other policy set. Lower rank is higher priority., property of the request body.
service_name (string) – Policy set service identifier - Allowed Protocols,Server Sequence.., property of the request body.
state (string) – The state that the policy set is in. A disabled policy set cannot be matched., property of the request body. Available values are ‘enabled’, ‘disabled’ and ‘monitor’.
id – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_policy_set_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Delete a policy set.
- Parameters
id (basestring) – id path parameter. Policy id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_profiles¶
- class NetworkAccessProfiles[source]¶
Identity Services Engine Network Access - Profiles API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Profiles API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_profiles(headers=None, **query_parameters)[source]¶
Network Access - Returns list of profiles.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_security_groups¶
- class NetworkAccessSecurityGroups[source]¶
Identity Services Engine Network Access - Security Groups API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Security Groups API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_security_groups(headers=None, **query_parameters)[source]¶
Network Access - Return list of available security groups for authorization policy definition.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_service_names¶
- class NetworkAccessServiceNames[source]¶
Identity Services Engine Network Access - Service Names API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Service Names API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_service_names(headers=None, **query_parameters)[source]¶
Network Access - Returns list of allowed protocols and server sequences for Policy Set.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_access_time_date_conditions¶
- class NetworkAccessTimeDateConditions[source]¶
Identity Services Engine Network Access - Time/Date Conditions API (version: 3.0.0).
Wraps the Identity Services Engine Network Access - Time/Date Conditions API and exposes the API as native Python methods that return native Python objects.
- get_all_network_access_time_conditions(headers=None, **query_parameters)[source]¶
Network Access - Returns a list of time and date conditions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_access_time_condition(attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, id=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Creates time/date condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (string) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_access_time_condition_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - returns a network condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_access_time_condition_by_id(id, attribute_id=None, attribute_name=None, attribute_value=None, children=None, condition_type=None, dates_range=None, dates_range_exception=None, description=None, dictionary_name=None, dictionary_value=None, hours_range=None, hours_range_exception=None, is_negate=None, name=None, operator=None, week_days=None, week_days_exception=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Network Access - Update network condition.
- Parameters
attribute_id (string) – Dictionary attribute id (Optional), used for additional verification, property of the request body.
attribute_name (string) – Dictionary attribute name, property of the request body.
attribute_value (string) – Attribute value for condition Value type is specified in dictionary object if multiple values allowed is specified in dictionary object, property of the request body.
children (list) – In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition, property of the request body (list of objects).
condition_type (string) – Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation Data type enum(reference,single) indicates than “conditonId” OR “ConditionAttrs” fields should contain condition data but not both Logical aggreation(and,or) enum indicates that additional conditions are present under the children field, property of the request body. Available values are ‘ConditionReference’, ‘ConditionAttributes’, ‘LibraryConditionAttributes’, ‘ConditionAndBlock’, ‘LibraryConditionAndBlock’, ‘ConditionOrBlock’, ‘LibraryConditionOrBlock’ and ‘TimeAndDateCondition’.
dates_range (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
dates_range_exception (object) – Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty Options are - Date range, for specific date, the same date should be used for start/end date Default - no specific dates In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year), property of the request body.
description (string) – Condition description, property of the request body.
dictionary_name (string) – Dictionary name, property of the request body.
dictionary_value (string) – Dictionary value, property of the request body.
hours_range (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
hours_range_exception (object) – Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property Time foramt - hh:mm ( h = hour , mm = minutes ) Default - All Day , property of the request body.
id (basestring) – id, property of the request body.
is_negate (boolean) – Indicates whereas this condition is in negate mode, property of the request body.
name (string) – Condition name, property of the request body.
operator (string) – Equality operator, property of the request body. Available values are ‘equals’, ‘notEquals’, ‘contains’, ‘notContains’, ‘matches’, ‘in’, ‘notIn’, ‘startsWith’, ‘notStartsWith’, ‘endsWith’, ‘notEndsWith’, ‘greaterThan’, ‘lessThan’, ‘greaterOrEquals’, ‘lessOrEquals’, ‘macEquals’, ‘macNotEquals’, ‘macNotIn’, ‘macIn’, ‘macStartsWith’, ‘macNotStartsWith’, ‘macEndsWith’, ‘macNotEndsWith’, ‘macContains’, ‘macNotContains’, ‘ipGreaterThan’, ‘ipLessThan’, ‘ipEquals’, ‘ipNotEquals’, ‘dateTimeMatches’, ‘dateLessThan’, ‘dateLessThanOrEquals’, ‘dateGreaterThan’, ‘dateGreaterThanOrEquals’, ‘dateEquals’ and ‘dateNotEquals’.
weekDays (list) – Defines for which days this condition will be matched Days format - Arrays of WeekDay enums Default - List of All week days, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
weekDaysException (list) – Defines for which days this condition will NOT be matched Days format - Arrays of WeekDay enums Default - Not enabled, property of the request body (list of strings. Available values are ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’ and ‘Saturday’).
id – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_access_time_condition_by_id(id, headers=None, **query_parameters)[source]¶
Network Access - Delete Time/Date condition.
- Parameters
id (basestring) – id path parameter. Condition id.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_device¶
- class NetworkDevice[source]¶
Identity Services Engine NetworkDevice API (version: 3.0.0).
Wraps the Identity Services Engine NetworkDevice API and exposes the API as native Python methods that return native Python objects.
- get_all_network_device(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Network Device.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_network_device_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Network Device.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_device(authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Network Device.
- Parameters
NetworkDeviceGroupList (list) – NetworkDeviceGroupList, property of the request body (list of strings).
NetworkDeviceIPList (list) – NetworkDeviceIPList, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – dtlsDnsName, property of the request body.
name (string) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_device_by_id(id, headers=None, **query_parameters)[source]¶
Get Network Device by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_device_by_id(id, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Network Device.
- Parameters
NetworkDeviceGroupList (list) – NetworkDeviceGroupList, property of the request body (list of strings).
NetworkDeviceIPList (list) – NetworkDeviceIPList, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – dtlsDnsName, property of the request body.
name (string) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_device_by_id(id, headers=None, **query_parameters)[source]¶
Delete Network Device.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_device_by_name(name, headers=None, **query_parameters)[source]¶
Get Network Device by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_device_by_name(name, authentication_settings=None, coa_port=None, description=None, dtls_dns_name=None, network_device_group_list=None, network_device_iplist=None, profile_name=None, snmpsettings=None, tacacs_settings=None, trustsecsettings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Network Device by name.
- Parameters
NetworkDeviceGroupList (list) – NetworkDeviceGroupList, property of the request body (list of strings).
NetworkDeviceIPList (list) – NetworkDeviceIPList, property of the request body (list of objects).
authentication_settings (object) – authenticationSettings, property of the request body.
coa_port (integer) – coaPort, property of the request body.
description (string) – description, property of the request body.
dtls_dns_name (string) – dtlsDnsName, property of the request body.
name (basestring) – name, property of the request body.
profile_name (string) – profileName, property of the request body.
snmpsettings (object) – snmpsettings, property of the request body.
tacacs_settings (object) – tacacsSettings, property of the request body.
trustsecsettings (object) – trustsecsettings, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_device_by_name(name, headers=None, **query_parameters)[source]¶
Delete Network Device by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_network_device(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for Network Device.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_network_device(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for Network Device.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
network_device_group¶
- class NetworkDeviceGroup[source]¶
Identity Services Engine NetworkDeviceGroup API (version: 3.0.0).
Wraps the Identity Services Engine NetworkDeviceGroup API and exposes the API as native Python methods that return native Python objects.
- get_all_network_device_group(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Network Device Group.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_network_device_group_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Network Device Group.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_network_device_group(description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Network Device Group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
othername (string) – othername, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_device_group_by_id(id, headers=None, **query_parameters)[source]¶
Get Network Device Group by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_network_device_group_by_id(id, description=None, name=None, othername=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Network Device Group.
- Parameters
description (string) – description, property of the request body.
name (string) – name, property of the request body.
othername (string) – othername, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_network_device_group_by_id(id, headers=None, **query_parameters)[source]¶
Delete Network Device Group.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_network_device_group_by_name(name, headers=None, **query_parameters)[source]¶
Get Network Device Group by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
node¶
- class Node[source]¶
Identity Services Engine Node API (version: 3.0.0).
Wraps the Identity Services Engine Node API and exposes the API as native Python methods that return native Python objects.
- get_all_nodes(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Node.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_nodes_generator(filter=None, filter_type=None, page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Node.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_node_by_id(id, headers=None, **query_parameters)[source]¶
Get Node by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_node_by_name(name, headers=None, **query_parameters)[source]¶
Get Node by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
node_deployment¶
- class NodeDeployment[source]¶
Identity Services Engine Node Deployment API (version: 3.0.0).
Wraps the Identity Services Engine Node Deployment API and exposes the API as native Python methods that return native Python objects.
- get_all_nodes(headers=None, **query_parameters)[source]¶
Discovers all deployment nodes in the cluster. It provides basic information about each of deployed nodes in the cluster like Hostname, personas, status, roles and services. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- register_node(administration=None, fdqn=None, general_settings=None, password=None, profile_configuration=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Register ISE node to form a multi-node deployment .
- Parameters
administration (object) – administration, property of the request body.
fdqn (string) – fdqn, property of the request body. Constraints: maxLength set to 256 and minLength set to 1.
general_settings (object) – generalSettings, property of the request body.
password (string) – password, property of the request body.
profile_configuration (object) – profileConfiguration, property of the request body.
user_name (string) – userName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- promote_node(promotion_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Changes the cluster setting by promoting a node to primary when exceuted on standalone or secondary node. It could also be used to convert a deployment node to standalone node. .
- Parameters
promotion_type (string) – promotionType, property of the request body. Available values are ‘SECONDARY_TO_PRIMARY’, ‘STANDALONE_TO_PRIMARY’ and ‘TO_STANDALONE’.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_node_details(hostname, headers=None, **query_parameters)[source]¶
It provides detailed information of the deployed node in the cluster. .
- Parameters
hostname (basestring) – hostname path parameter. ID of the existing deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_node(hostname, general_settings=None, profile_configuration=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Updates the deployed ISE node with the information provided .
- Parameters
general_settings (object) – generalSettings, property of the request body.
profile_configuration (object) – profileConfiguration, property of the request body.
hostname (basestring) – hostname path parameter. ID of the existing deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_node(hostname, headers=None, **query_parameters)[source]¶
The de-register ednode becomes a standalone Cisco ISE node. It retains the last configuration that it received rom the PrimaryPAN and assumes the default personas of a standalone node that are Administration, PolicyService, and Monitoring. .
- Parameters
hostname (basestring) – hostname path parameter. node name of the existing deployed node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
node_group¶
- class NodeGroup[source]¶
Identity Services Engine Node Group API (version: 3.0.0).
Wraps the Identity Services Engine Node Group API and exposes the API as native Python methods that return native Python objects.
- get_node_groups(headers=None, **query_parameters)[source]¶
Get details of all the node groups in the cluster. To detect node failure and to reset all URL-redirected sessions on the failed node, two or more Policy Service nodes can be placed in the same node group. When a node that belongs to a node group fails, another node in the same node group issues a Change of Authorization (CoA) for all URL-redirected sessions on the failed node.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_node_group(node_group_name, headers=None, **query_parameters)[source]¶
Get details of a node group in the cluster.
- Parameters
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_node_group(node_group_name, description=None, mar_cache=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Developers need to create node group in the system.Node Group is a group of PSNs, mainly used for terminating posture pending sessions when a PSN in local node group fails.Node group members can communicate over TCP/7800.
- Parameters
description (string) – description, property of the request body. Constraints: maxLength set to 256 and minLength set to 1.
mar_cache (object) – mar-cache, property of the request body.
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_node_group(node_group_name, description=None, mar_cache=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
API updates an existing node group in the system.
- Parameters
description (string) – description, property of the request body. Constraints: maxLength set to 256 and minLength set to 1.
mar_cache (object) – mar-cache, property of the request body.
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_node_group(node_group_name, headers=None, **query_parameters)[source]¶
Developers need to delete node group in the system.
- Parameters
node_group_name (basestring) – node-group-name path parameter. ID of the existing node group.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
pan_ha¶
- class PanHa[source]¶
Identity Services Engine PAN HA API (version: 3.0.0).
Wraps the Identity Services Engine PAN HA API and exposes the API as native Python methods that return native Python objects.
- get_pan_ha_status(headers=None, **query_parameters)[source]¶
In a high availability configuration, the Primary Administration Node (PAN) is in the active state. The Secondary PAN (backup PAN) is in the standby state, which means it receives all configuration updates from the Primary PAN, but is not active in the ISE network. You can configure ISE to automatically the promote the secondary PAN when the primary PAN becomes unavailable.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- enable_pan_ha(failed_attempts=None, is_enabled=None, polling_interval=None, primary_health_check_node=None, secondary_health_check_node=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
To deploy the auto-failover feature, you must have at least three nodes, where two of the nodes assume the Administration persona, and one node acts as the health check node. A health check node is a non-administration node and can be a Policy Service, Monitoring, or pxGrid node, or a combination of these. If the PANs are in different data centers, you must have a health check node for each PAN.
- Parameters
failed_attempts (integer) – failedAttempts, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
polling_interval (integer) – pollingInterval, property of the request body.
primary_health_check_node (string) – primaryHealthCheckNode, property of the request body. Constraints: maxLength set to 64 and minLength set to 1.
secondary_health_check_node (string) – secondaryHealthCheckNode, property of the request body. Constraints: maxLength set to 64 and minLength set to 1.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- disable_pan_ha(headers=None, **query_parameters)[source]¶
Disable the automatic PAN failover.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
portal¶
- class Portal[source]¶
Identity Services Engine Portal API (version: 3.0.0).
Wraps the Identity Services Engine Portal API and exposes the API as native Python methods that return native Python objects.
- get_all_portals(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_portals_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_portal_by_id(id, headers=None, **query_parameters)[source]¶
Get Portal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
portal_global_setting¶
- class PortalGlobalSetting[source]¶
Identity Services Engine PortalGlobalSetting API (version: 3.0.0).
Wraps the Identity Services Engine PortalGlobalSetting API and exposes the API as native Python methods that return native Python objects.
- get_all_portal_global_settings(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Portal Global Setting.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_portal_global_settings_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Portal Global Setting.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_portal_global_setting_by_id(id, headers=None, **query_parameters)[source]¶
Get Portal Global Setting by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_portal_global_setting_by_id(id, customization=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Portal Global Setting.
- Parameters
customization (string) – customization, property of the request body.
id (basestring) – id, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
portal_theme¶
- class PortalTheme[source]¶
Identity Services Engine PortalTheme API (version: 3.0.0).
Wraps the Identity Services Engine PortalTheme API and exposes the API as native Python methods that return native Python objects.
- get_all_portal_themes(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Portal Theme.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_portal_themes_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Portal Theme.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_portal_theme(name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Portal Theme.
- Parameters
name (string) – name, property of the request body.
theme_data (string) – themeData, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_portal_theme_by_id(id, headers=None, **query_parameters)[source]¶
Get Portal Theme by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_portal_theme_by_id(id, name=None, theme_data=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Portal Theme.
- Parameters
name (string) – name, property of the request body.
theme_data (string) – themeData, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_portal_theme_by_id(id, headers=None, **query_parameters)[source]¶
Delete Portal Theme by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
profiler¶
- class Profiler[source]¶
Identity Services Engine Profiler API (version: 3.0.0).
Wraps the Identity Services Engine Profiler API and exposes the API as native Python methods that return native Python objects.
- get_profiles(headers=None, **query_parameters)[source]¶
🚧 getProfiles.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
profiler_profile¶
- class ProfilerProfile[source]¶
Identity Services Engine ProfilerProfile API (version: 3.0.0).
Wraps the Identity Services Engine ProfilerProfile API and exposes the API as native Python methods that return native Python objects.
- get_all_profiler_profiles(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all ProfilerProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_profiler_profiles_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all ProfilerProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_profiler_profile_by_id(id, headers=None, **query_parameters)[source]¶
Get ProfilerProfile by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
provider¶
- class Provider[source]¶
Identity Services Engine Provider API (version: 3.0.0).
Wraps the Identity Services Engine Provider API and exposes the API as native Python methods that return native Python objects.
- register_service(name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
🚧 ServiceRegister.
- Parameters
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- unregister_service(headers=None, **query_parameters)[source]¶
🚧 ServiceUnregister.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- reregister_service(headers=None, **query_parameters)[source]¶
🚧 ServiceReregister.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- authorization(headers=None, **query_parameters)[source]¶
🚧 Authorization.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
radius_failure¶
- class RadiusFailure[source]¶
Identity Services Engine RADIUS Failure API (version: 3.0.0).
Wraps the Identity Services Engine RADIUS Failure API and exposes the API as native Python methods that return native Python objects.
- get_failures(headers=None, **query_parameters)[source]¶
🚧 getFailures.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
radius_server_sequence¶
- class RadiusServerSequence[source]¶
Identity Services Engine RADIUSServerSequence API (version: 3.0.0).
Wraps the Identity Services Engine RADIUSServerSequence API and exposes the API as native Python methods that return native Python objects.
- get_all_radius_server_sequence(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all RADIUSServerSequence.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_radius_server_sequence_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all RADIUSServerSequence.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_radius_server_sequence(before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, id=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create RADIUSServerSequence.
- Parameters
BeforeAcceptAttrManipulatorsList (list) – BeforeAcceptAttrManipulatorsList, property of the request body (list of objects).
OnRequestAttrManipulatorList (list) – OnRequestAttrManipulatorList, property of the request body (list of objects).
RadiusServerList (list) – RadiusServerList, property of the request body (list of strings).
continue_authorz_policy (boolean) – continueAuthorzPolicy, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_separator (string) – prefixSeparator, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
strip_prefix (boolean) – stripPrefix, property of the request body.
strip_suffix (boolean) – stripSuffix, property of the request body.
suffix_separator (string) – suffixSeparator, property of the request body.
use_attr_set_before_acc (boolean) – useAttrSetBeforeAcc, property of the request body.
use_attr_set_on_request (boolean) – useAttrSetOnRequest, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_radius_server_sequence_by_id(id, headers=None, **query_parameters)[source]¶
Get RADIUSServerSequence by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_radius_server_sequence_by_id(id, before_accept_attr_manipulators_list=None, continue_authorz_policy=None, description=None, local_accounting=None, name=None, on_request_attr_manipulator_list=None, prefix_separator=None, radius_server_list=None, remote_accounting=None, strip_prefix=None, strip_suffix=None, suffix_separator=None, use_attr_set_before_acc=None, use_attr_set_on_request=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update RADIUSServerSequence.
- Parameters
BeforeAcceptAttrManipulatorsList (list) – BeforeAcceptAttrManipulatorsList, property of the request body (list of objects).
OnRequestAttrManipulatorList (list) – OnRequestAttrManipulatorList, property of the request body (list of objects).
RadiusServerList (list) – RadiusServerList, property of the request body (list of strings).
continue_authorz_policy (boolean) – continueAuthorzPolicy, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_separator (string) – prefixSeparator, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
strip_prefix (boolean) – stripPrefix, property of the request body.
strip_suffix (boolean) – stripSuffix, property of the request body.
suffix_separator (string) – suffixSeparator, property of the request body.
use_attr_set_before_acc (boolean) – useAttrSetBeforeAcc, property of the request body.
use_attr_set_on_request (boolean) – useAttrSetOnRequest, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_radius_server_sequence_by_id(id, headers=None, **query_parameters)[source]¶
Delete RADIUSServerSequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
restid_store¶
- class RestidStore[source]¶
Identity Services Engine RESTIDStore API (version: 3.0.0).
Wraps the Identity Services Engine RESTIDStore API and exposes the API as native Python methods that return native Python objects.
- get_all_rest_id_store(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all REST ID Store.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_rest_id_store_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all REST ID Store.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_rest_id_store(description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create REST ID Store.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_rest_id_store_by_id(id, headers=None, **query_parameters)[source]¶
Get REST ID Store by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_rest_id_store_by_id(id, description=None, ers_rest_idstore_attributes=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update REST ID Store.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
name (string) – name, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_rest_id_store_by_id(id, headers=None, **query_parameters)[source]¶
Delete REST ID Store.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_rest_id_store_by_name(name, headers=None, **query_parameters)[source]¶
Get REST ID Store by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_rest_id_store_by_name(name, description=None, ers_rest_idstore_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update REST ID Store by name.
- Parameters
description (string) – description, property of the request body.
ers_rest_idstore_attributes (object) – ersRestIDStoreAttributes, property of the request body.
name (basestring) – name, property of the request body.
name – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_rest_id_store_by_name(name, headers=None, **query_parameters)[source]¶
Delete REST ID Store by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
replication_status¶
- class ReplicationStatus[source]¶
Identity Services Engine Replication Status API (version: 3.0.0).
Wraps the Identity Services Engine Replication Status API and exposes the API as native Python methods that return native Python objects.
- get_node_replication_status(node, headers=None, **query_parameters)[source]¶
Retrives replication status of a node.
- Parameters
node (basestring) – node path parameter. ID of the existing node.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
repository¶
- class Repository[source]¶
Identity Services Engine Repository API (version: 3.0.0).
Wraps the Identity Services Engine Repository API and exposes the API as native Python methods that return native Python objects.
- get_repositories(headers=None, **query_parameters)[source]¶
This will get the full list of repository definitions on the system. .
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_repository(enable_pki=None, name=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create a new repository in the system. The name provided for the repository must be unique. .
- Parameters
enable_pki (boolean) – enablePki, property of the request body.
name (string) – name, property of the request body. Constraints: maxLength set to 80 and minLength set to 1.
password (string) – password, property of the request body.
path (string) – path, property of the request body.
protocol (string) – protocol, property of the request body. Available values are ‘DISK’, ‘FTP’, ‘SFTP’, ‘TFTP’, ‘NFS’, ‘CDROM’, ‘HTTP’ and ‘HTTPS’.
server_name (string) – serverName, property of the request body.
user_name (string) – userName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_repository_by_name(name, headers=None, **query_parameters)[source]¶
Get a specific repository identified by the name passed in the URL. .
- Parameters
name (basestring) – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_repository_by_name(name, enable_pki=None, password=None, path=None, protocol=None, server_name=None, user_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update the definition of a specific repository, providing ALL parameters for the repository. .
- Parameters
enable_pki (boolean) – enablePki, property of the request body.
name (basestring) – name, property of the request body. Constraints: maxLength set to 80 and minLength set to 1.
password (string) – password, property of the request body.
path (string) – path, property of the request body.
protocol (string) – protocol, property of the request body. Available values are ‘DISK’, ‘FTP’, ‘SFTP’, ‘TFTP’, ‘NFS’, ‘CDROM’, ‘HTTP’ and ‘HTTPS’.
server_name (string) – serverName, property of the request body.
user_name (string) – userName, property of the request body.
name – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_repository_by_name(name, headers=None, **query_parameters)[source]¶
Long description TBD .
- Parameters
name (basestring) – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_repository_files(name, headers=None, **query_parameters)[source]¶
This will get the full list of files present in the named repository. .
- Parameters
name (basestring) – name path parameter. Unique name for a repository.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sg_acl¶
- class SgAcl[source]¶
Identity Services Engine SGACL API (version: 3.0.0).
Wraps the Identity Services Engine SGACL API and exposes the API as native Python methods that return native Python objects.
- get_all_security_groups_acl(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGACL.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_security_groups_acl_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGACL.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_security_groups_acl(aclcontent=None, description=None, id=None, ip_version=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SGACL.
- Parameters
aclcontent (string) – aclcontent, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
ip_version (string) – ipVersion, property of the request body.
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_security_groups_acl_by_id(id, headers=None, **query_parameters)[source]¶
Get SGACL by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_security_groups_acl_by_id(id, aclcontent=None, description=None, ip_version=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update SGACL.
- Parameters
aclcontent (string) – aclcontent, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
ip_version (string) – ipVersion, property of the request body.
name (string) – name, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_security_groups_acl_by_id(id, headers=None, **query_parameters)[source]¶
Delete SGACL.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_security_groups_acl(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SGACL.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_security_groups_acl(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SGACL.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sg_mapping¶
- class SgMapping[source]¶
Identity Services Engine SGMapping API (version: 3.0.0).
Wraps the Identity Services Engine SGMapping API and exposes the API as native Python methods that return native Python objects.
- get_all_ip_to_sgt_mapping(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGMapping.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_ip_to_sgt_mapping_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGMapping.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_ip_to_sgt_mapping(deploy_to=None, deploy_type=None, host_name=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SGMapping.
- Parameters
deploy_to (string) – deployTo, property of the request body.
deploy_type (string) – deployType, property of the request body.
host_name (string) – hostName, property of the request body.
name (string) – name, property of the request body.
sgt (string) – sgt, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_ip_to_sgt_mapping_by_id(id, headers=None, **query_parameters)[source]¶
Get SGMapping by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_ip_to_sgt_mapping_by_id(id, deploy_to=None, deploy_type=None, host_name=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update SGMapping.
- Parameters
deploy_to (string) – deployTo, property of the request body.
deploy_type (string) – deployType, property of the request body.
host_name (string) – hostName, property of the request body.
name (string) – name, property of the request body.
sgt (string) – sgt, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_ip_to_sgt_mapping_by_id(id, headers=None, **query_parameters)[source]¶
Delete SGMapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- deploy_ip_to_sgt_mapping_by_id(id, headers=None, **query_parameters)[source]¶
Deploy SGMapping.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- deploy_all_ip_to_sgt_mapping(headers=None, **query_parameters)[source]¶
Deploy all SGMapping.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_deploy_status_ip_to_sgt_mapping(headers=None, **query_parameters)[source]¶
Get all SGMapping.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_ip_to_sgt_mapping(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SG Mapping.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_ip_to_sgt_mapping(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SG Mapping.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sg_mapping_group¶
- class SgMappingGroup[source]¶
Identity Services Engine SGMappingGroup API (version: 3.0.0).
Wraps the Identity Services Engine SGMappingGroup API and exposes the API as native Python methods that return native Python objects.
- get_all_ip_to_sgt_mapping_group(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGMappingGroup.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_ip_to_sgt_mapping_group_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGMappingGroup.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_ip_to_sgt_mapping_group(deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SGMappingGroup.
- Parameters
deploy_to (string) – deployTo, property of the request body.
deploy_type (string) – deployType, property of the request body.
name (string) – name, property of the request body.
sgt (string) – sgt, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_ip_to_sgt_mapping_group_by_id(id, headers=None, **query_parameters)[source]¶
Get SGMappingGroup by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_ip_to_sgt_mapping_group_by_id(id, deploy_to=None, deploy_type=None, name=None, sgt=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update SGMappingGroup.
- Parameters
deploy_to (string) – deployTo, property of the request body.
deploy_type (string) – deployType, property of the request body.
name (string) – name, property of the request body.
sgt (string) – sgt, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_ip_to_sgt_mapping_group_by_id(id, headers=None, **query_parameters)[source]¶
Delete SGMappingGroup.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- deploy_ip_to_sgt_mapping_group_by_id(id, headers=None, **query_parameters)[source]¶
Deploy SGMappingGroup.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- deploy_all_ip_to_sgt_mapping_group(headers=None, **query_parameters)[source]¶
Deploy all SGMappingGroup.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_deploy_status_ip_to_sgt_mapping_group(headers=None, **query_parameters)[source]¶
Get all SGMappingGroup.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_ip_to_sgt_mapping_group(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SG Mapping Group.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_ip_to_sgt_mapping_group(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SG Mapping Group.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sgt¶
- class Sgt[source]¶
Identity Services Engine SGT API (version: 3.0.0).
Wraps the Identity Services Engine SGT API and exposes the API as native Python methods that return native Python objects.
- get_all_security_groups(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGT.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_security_groups_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SGT.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_security_group(description=None, generation_id=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SGT.
- Parameters
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
name (string) – name, property of the request body.
propogate_to_apic (boolean) – propogateToApic, property of the request body.
value (integer) – value, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_security_group_by_id(id, headers=None, **query_parameters)[source]¶
Get SGT by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_security_group_by_id(id, description=None, generation_id=None, name=None, propogate_to_apic=None, value=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update SGT.
- Parameters
description (string) – description, property of the request body.
generation_id (string) – generationId, property of the request body.
name (string) – name, property of the request body.
propogate_to_apic (boolean) – propogateToApic, property of the request body.
value (integer) – value, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_security_group_by_id(id, headers=None, **query_parameters)[source]¶
Delete SGT.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_security_group(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SGT.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_security_group(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SGT.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sgt_vn_vlan¶
- class SgtVnVlan[source]¶
Identity Services Engine SGTVNVLAN API (version: 3.0.0).
Wraps the Identity Services Engine SGTVNVLAN API and exposes the API as native Python methods that return native Python objects.
- get_all_security_groups_to_vn_to_vlan(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all SGTVNVLAN.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_security_groups_to_vn_to_vlan_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all SGTVNVLAN.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_security_groups_to_vn_to_vlan(description=None, id=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SGTVNVLAN.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
sgt_id (string) – sgtId, property of the request body.
virtualnetworklist (list) – virtualnetworklist, property of the request body (list of objects).
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_security_groups_to_vn_to_vlan_by_id(id, headers=None, **query_parameters)[source]¶
Get SGTVNVLAN by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_security_groups_to_vn_to_vlan_by_id(id, description=None, name=None, sgt_id=None, virtualnetworklist=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update SGTVNVLAN.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
sgt_id (string) – sgtId, property of the request body.
virtualnetworklist (list) – virtualnetworklist, property of the request body (list of objects).
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_security_groups_to_vn_to_vlan_by_id(id, headers=None, **query_parameters)[source]¶
Delete SGTVNVLAN.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_security_groups_to_vn_to_vlan(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SGTVNVLAN.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_security_groups_to_vn_to_vlan(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SGTVNVLAN.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sms_provider¶
- class SmsProvider[source]¶
Identity Services Engine SMSProvider API (version: 3.0.0).
Wraps the Identity Services Engine SMSProvider API and exposes the API as native Python methods that return native Python objects.
- get_all_sms_provider(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SMS provider.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sms_provider_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SMS provider.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sms_provider_by_id(id, headers=None, **query_parameters)[source]¶
Get SMS provider by ID.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sxp_connections¶
- class SxpConnections[source]¶
Identity Services Engine SXPConnections API (version: 3.0.0).
Wraps the Identity Services Engine SXPConnections API and exposes the API as native Python methods that return native Python objects.
- get_all_sxp_connections(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SXPConnections.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sxp_connections_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SXPConnections.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_sxp_connections(description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SXPConnections.
- Parameters
description (string) – description, property of the request body.
enabled (boolean) – enabled, property of the request body.
ip_address (string) – ipAddress, property of the request body.
sxp_mode (string) – sxpMode, property of the request body.
sxp_node (string) – sxpNode, property of the request body.
sxp_peer (string) – sxpPeer, property of the request body.
sxp_version (string) – sxpVersion, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sxp_connections_by_id(id, headers=None, **query_parameters)[source]¶
Get SXPConnections by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_sxp_connections_by_id(id, description=None, enabled=None, ip_address=None, sxp_mode=None, sxp_node=None, sxp_peer=None, sxp_version=None, sxp_vpn=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update SXPConnections.
- Parameters
description (string) – description, property of the request body.
enabled (boolean) – enabled, property of the request body.
ip_address (string) – ipAddress, property of the request body.
sxp_mode (string) – sxpMode, property of the request body.
sxp_node (string) – sxpNode, property of the request body.
sxp_peer (string) – sxpPeer, property of the request body.
sxp_version (string) – sxpVersion, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_sxp_connections_by_id(id, headers=None, **query_parameters)[source]¶
Delete SXPConnections.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_sxp_connections(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SXP Connections.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_sxp_connections(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SXP Connections.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sxp_local_bindings¶
- class SxpLocalBindings[source]¶
Identity Services Engine SXPLocalBindings API (version: 3.0.0).
Wraps the Identity Services Engine SXPLocalBindings API and exposes the API as native Python methods that return native Python objects.
- get_all_sxp_local_bindings(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SXPLocalBindings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sxp_local_bindings_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SXPLocalBindings.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_sxp_local_bindings(binding_name=None, description=None, id=None, ip_address_or_host=None, name=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SXPLocalBindings.
- Parameters
binding_name (string) – bindingName, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
ip_address_or_host (string) – ipAddressOrHost, property of the request body.
name (string) – name, property of the request body.
sgt (string) – sgt, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
vns (string) – vns, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sxp_local_bindings_by_id(id, headers=None, **query_parameters)[source]¶
Get SXPLocalBindings by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_sxp_local_bindings_by_id(id, binding_name=None, description=None, ip_address_or_host=None, name=None, sgt=None, sxp_vpn=None, vns=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update SXPLocalBindings.
- Parameters
binding_name (string) – bindingName, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
ip_address_or_host (string) – ipAddressOrHost, property of the request body.
name (string) – name, property of the request body.
sgt (string) – sgt, property of the request body.
sxp_vpn (string) – sxpVpn, property of the request body.
vns (string) – vns, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_sxp_local_bindings_by_id(id, headers=None, **query_parameters)[source]¶
Delete SXPLocalBindings.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_sxp_local_bindings(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SXP Local Bindings.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_sxp_local_bindings(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SXP Local Bindings.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sxp_vpns¶
- class SxpVpns[source]¶
Identity Services Engine SXPVPNs API (version: 3.0.0).
Wraps the Identity Services Engine SXPVPNs API and exposes the API as native Python methods that return native Python objects.
- get_all_sxp_vpns(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SXPVPNs.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sxp_vpns_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all SXPVPNs.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_sxp_vpn(id=None, sxp_vpn_name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SXPVPNs.
- Parameters
id (string) – id, property of the request body.
sxp_vpn_name (string) – sxpVpnName, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sxp_vpn_by_id(id, headers=None, **query_parameters)[source]¶
Get SXPVPNs by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_sxp_vpn_by_id(id, headers=None, **query_parameters)[source]¶
Delete SXPVPNs.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- bulk_request_for_sxp_vpns(operation_type=None, resource_media_type=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Bulk request for SXPVPNs.
- Parameters
operation_type (string) – operationType, property of the request body.
resource_media_type (string) – resourceMediaType, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- monitor_bulk_status_sxp_vpns(bulkid, headers=None, **query_parameters)[source]¶
Monitor bulk status for SXP VPNs.
- Parameters
bulkid (basestring) – bulkid path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
self_registered_portal¶
- class SelfRegisteredPortal[source]¶
Identity Services Engine SelfRegisteredPortal API (version: 3.0.0).
Wraps the Identity Services Engine SelfRegisteredPortal API and exposes the API as native Python methods that return native Python objects.
- get_all_self_registered_portals(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Self Registered Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_self_registered_portals_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Self Registered Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_self_registered_portal(customizations=None, description=None, id=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Self Registered Portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_self_registered_portal_by_id(id, headers=None, **query_parameters)[source]¶
Get Self Registered Portal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_self_registered_portal_by_id(id, customizations=None, description=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Self Registered Portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_self_registered_portal_by_id(id, headers=None, **query_parameters)[source]¶
Delete Self Registered Portal.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
service¶
- class Service[source]¶
Identity Services Engine Service API (version: 3.0.0).
Wraps the Identity Services Engine Service API and exposes the API as native Python methods that return native Python objects.
- get_all_service(headers=None, **query_parameters)[source]¶
Get all Service.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_service_by_name(name, headers=None, **query_parameters)[source]¶
Get Service by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
session_directory¶
- class SessionDirectory[source]¶
Identity Services Engine Session Directory API (version: 3.0.0).
Wraps the Identity Services Engine Session Directory API and exposes the API as native Python methods that return native Python objects.
- get_sessions(headers=None, **query_parameters)[source]¶
🚧 getSessions.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sessions_for_recovery(headers=None, **query_parameters)[source]¶
🚧 getSessionsForRecovery.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_session_by_ip_address(headers=None, **query_parameters)[source]¶
🚧 getSessionByIpAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_session_by_mac_address(headers=None, **query_parameters)[source]¶
🚧 getSessionByMacAddress.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_user_groups(headers=None, **query_parameters)[source]¶
🚧 getUserGroups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_user_group_by_user_name(headers=None, **query_parameters)[source]¶
🚧 getUserGroupByUserName.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
session_service_node¶
- class SessionServiceNode[source]¶
Identity Services Engine SessionServiceNode API (version: 3.0.0).
Wraps the Identity Services Engine SessionServiceNode API and exposes the API as native Python methods that return native Python objects.
- get_all_session_service_node(headers=None, **query_parameters)[source]¶
Get all SessionServiceNode.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_session_service_node_by_id(id, headers=None, **query_parameters)[source]¶
Get SessionServiceNode by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_session_service_node_by_name(name, headers=None, **query_parameters)[source]¶
Get SessionServiceNode by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsor_group¶
- class SponsorGroup[source]¶
Identity Services Engine SponsorGroup API (version: 3.0.0).
Wraps the Identity Services Engine SponsorGroup API and exposes the API as native Python methods that return native Python objects.
- get_all_sponsor_group(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Sponsor Group.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sponsor_group_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Sponsor Group.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_sponsor_group(auto_notification=None, create_permissions=None, description=None, guest_types=None, id=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Sponsor Group.
- Parameters
auto_notification (boolean) – autoNotification, property of the request body.
create_permissions (object) – createPermissions, property of the request body.
description (string) – description, property of the request body.
guestTypes (list) – guestTypes, property of the request body (list of strings).
id (string) – id, property of the request body.
is_default_group (boolean) – isDefaultGroup, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
locations (list) – locations, property of the request body (list of strings).
manage_permission (string) – managePermission, property of the request body.
memberGroups (list) – memberGroups, property of the request body (list of strings).
name (string) – name, property of the request body.
other_permissions (object) – otherPermissions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sponsor_group_by_id(id, headers=None, **query_parameters)[source]¶
Get Sponsor Group by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_sponsor_group_by_id(id, auto_notification=None, create_permissions=None, description=None, guest_types=None, is_default_group=None, is_enabled=None, locations=None, manage_permission=None, member_groups=None, name=None, other_permissions=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Sponsor Group by Id.
- Parameters
auto_notification (boolean) – autoNotification, property of the request body.
create_permissions (object) – createPermissions, property of the request body.
description (string) – description, property of the request body.
guestTypes (list) – guestTypes, property of the request body (list of strings).
id (basestring) – id, property of the request body.
is_default_group (boolean) – isDefaultGroup, property of the request body.
is_enabled (boolean) – isEnabled, property of the request body.
locations (list) – locations, property of the request body (list of strings).
manage_permission (string) – managePermission, property of the request body.
memberGroups (list) – memberGroups, property of the request body (list of strings).
name (string) – name, property of the request body.
other_permissions (object) – otherPermissions, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_sponsor_group_by_id(id, headers=None, **query_parameters)[source]¶
Delete Sponsor Group by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsor_group_member¶
- class SponsorGroupMember[source]¶
Identity Services Engine SponsorGroupMember API (version: 3.0.0).
Wraps the Identity Services Engine SponsorGroupMember API and exposes the API as native Python methods that return native Python objects.
- get_all_sponsor_group_member(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Sponsor Group Member.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sponsor_group_member_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Sponsor Group Member.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sponsor_group_member_by_id(id, headers=None, **query_parameters)[source]¶
Get Sponsor Group Member by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsor_portal¶
- class SponsorPortal[source]¶
Identity Services Engine SponsorPortal API (version: 3.0.0).
Wraps the Identity Services Engine SponsorPortal API and exposes the API as native Python methods that return native Python objects.
- get_all_sponsor_portal(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Sponsor Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sponsor_portal_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all Sponsor Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_sponsor_portal(customizations=None, description=None, id=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Sponsor Portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – portalTestUrl, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sponsor_portal_by_id(id, headers=None, **query_parameters)[source]¶
Get Sponsor Portal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_sponsor_portal_by_id(id, customizations=None, description=None, name=None, portal_test_url=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Sponsor Portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_test_url (string) – portalTestUrl, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_sponsor_portal_by_id(id, headers=None, **query_parameters)[source]¶
Delete Sponsor Portal.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sponsored_guest_portal¶
- class SponsoredGuestPortal[source]¶
Identity Services Engine SponsoredGuestPortal API (version: 3.0.0).
Wraps the Identity Services Engine SponsoredGuestPortal API and exposes the API as native Python methods that return native Python objects.
- get_all_sponsored_guest_portals(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Sponsored Guest Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_sponsored_guest_portals_generator(filter=None, filter_type=None, page=None, size=None, sortasc=None, sortdsc=None, headers=None, **query_parameters)[source]¶
Get all Sponsored Guest Portal.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
filter (basestring, list, set, tuple) – filter query parameter. Simple filtering should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the “filterType=or” query string parameter. Each resource Data model description should specify if an attribute is a filtered field. (Operator: Description), (EQ: Equals), (NEQ: Not Equals), (GT: Greater Than), (LT: Less Then), (STARTSW: Starts With), (NSTARTSW: Not Starts With), (ENDSW: Ends With), (NENDSW: Not Ends With), (CONTAINS: Contains), (NCONTAINS: Not Contains), .
filter_type (basestring) – filterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter.
sortasc (basestring) – sortasc query parameter. sort asc.
sortdsc (basestring) – sortdsc query parameter. sort desc.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_sponsored_guest_portal(customizations=None, description=None, id=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create Sponsored Guest Portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_sponsored_guest_portal_by_id(id, headers=None, **query_parameters)[source]¶
Get Sponsored Guest Portal by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_sponsored_guest_portal_by_id(id, customizations=None, description=None, name=None, portal_type=None, settings=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update Sponsored Guest Portal.
- Parameters
customizations (object) – customizations, property of the request body.
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
portal_type (string) – portalType, property of the request body.
settings (object) – settings, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_sponsored_guest_portal_by_id(id, headers=None, **query_parameters)[source]¶
Delete Sponsored Guest Portal.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
support_bundle¶
- class SupportBundle[source]¶
Identity Services Engine SupportBundle API (version: 3.0.0).
Wraps the Identity Services Engine SupportBundle API and exposes the API as native Python methods that return native Python objects.
- download_support_bundle(file_name=None, dirpath=None, save_file=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Download SupportBundle.
- Parameters
file_name (string) – fileName, property of the request body.
dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().
save_file (bool) – Enable or disable automatic file creation of raw response.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
HTTP Response container. For more information check the urlib3 documentation
- Return type
urllib3.response.HTTPResponse
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_support_bundle_status(headers=None, **query_parameters)[source]¶
Get SupportBundle status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_support_bundle_status_by_id(id, headers=None, **query_parameters)[source]¶
Get SupportBundle by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_support_bundle(description=None, host_name=None, name=None, support_bundle_include_options=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create SupportBundle.
- Parameters
description (string) – description, property of the request body.
host_name (string) – hostName, property of the request body.
name (string) – name, property of the request body.
support_bundle_include_options (object) – supportBundleIncludeOptions, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
sync_ise_node¶
- class SyncIseNode[source]¶
Identity Services Engine Sync ISE Node API (version: 3.0.0).
Wraps the Identity Services Engine Sync ISE Node API and exposes the API as native Python methods that return native Python objects.
- sync_node(hostname=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Performing a manual sync will involve a reload of the target node, but not the primary PAN. There might be situations where if the node has been out of sync for a long time, it may not be possible to recover via a manual sync.
- Parameters
hostname (string) – hostname, property of the request body. Constraints: maxLength set to 64 and minLength set to 1.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
system_health¶
- class SystemHealth[source]¶
Identity Services Engine System Health API (version: 3.0.0).
Wraps the Identity Services Engine System Health API and exposes the API as native Python methods that return native Python objects.
- get_healths(headers=None, **query_parameters)[source]¶
🚧 getHealths.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_performances(headers=None, **query_parameters)[source]¶
🚧 getPerformances.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
system_certificate¶
- class SystemCertificate[source]¶
Identity Services Engine SystemCertificate API (version: 3.0.0).
Wraps the Identity Services Engine SystemCertificate API and exposes the API as native Python methods that return native Python objects.
- create_system_certificate(headers=None, **query_parameters)[source]¶
Create SystemCertificate.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_command_sets¶
- class TacacsCommandSets[source]¶
Identity Services Engine TACACSCommandSets API (version: 3.0.0).
Wraps the Identity Services Engine TACACSCommandSets API and exposes the API as native Python methods that return native Python objects.
- get_all_tacacs_command_sets(headers=None, **query_parameters)[source]¶
Get all TACACSCommandSets.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_tacacs_command_sets(commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create TACACSCommandSets.
- Parameters
commands (object) – commands, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
permit_unmatched (boolean) – permitUnmatched, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_command_sets_by_id(id, headers=None, **query_parameters)[source]¶
Get TACACSCommandSets by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_tacacs_command_sets_by_id(id, commands=None, description=None, name=None, permit_unmatched=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update TACACSCommandSets.
- Parameters
commands (object) – commands, property of the request body.
description (string) – description, property of the request body.
name (string) – name, property of the request body.
permit_unmatched (boolean) – permitUnmatched, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_tacacs_command_sets_by_id(id, headers=None, **query_parameters)[source]¶
Delete TACACSCommandSets.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_command_sets_by_name(name, headers=None, **query_parameters)[source]¶
Get TACACSCommandSets by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_external_servers¶
- class TacacsExternalServers[source]¶
Identity Services Engine TACACSExternalServers API (version: 3.0.0).
Wraps the Identity Services Engine TACACSExternalServers API and exposes the API as native Python methods that return native Python objects.
- get_all_tacacs_external_servers(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TACACSExternalServers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_tacacs_external_servers_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TACACSExternalServers.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_tacacs_external_servers(connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create TACACSExternalServers.
- Parameters
connection_port (integer) – connectionPort, property of the request body.
description (string) – description, property of the request body.
host_ip (string) – hostIP, property of the request body.
name (string) – name, property of the request body.
shared_secret (string) – sharedSecret, property of the request body.
single_connect (boolean) – singleConnect, property of the request body.
timeout (integer) – timeout, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_external_servers_by_id(id, headers=None, **query_parameters)[source]¶
Get TACACSExternalServers by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_tacacs_external_servers_by_id(id, connection_port=None, description=None, host_ip=None, name=None, shared_secret=None, single_connect=None, timeout=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update TACACSExternalServers.
- Parameters
connection_port (integer) – connectionPort, property of the request body.
description (string) – description, property of the request body.
host_ip (string) – hostIP, property of the request body.
name (string) – name, property of the request body.
shared_secret (string) – sharedSecret, property of the request body.
single_connect (boolean) – singleConnect, property of the request body.
timeout (integer) – timeout, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_tacacs_external_servers_by_id(id, headers=None, **query_parameters)[source]¶
Delete TACACSExternalServers.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_external_servers_by_name(name, headers=None, **query_parameters)[source]¶
Get TACACSExternalServers by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_profile¶
- class TacacsProfile[source]¶
Identity Services Engine TACACSProfile API (version: 3.0.0).
Wraps the Identity Services Engine TACACSProfile API and exposes the API as native Python methods that return native Python objects.
- get_all_tacacs_profile(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TACACSProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_tacacs_profile_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TACACSProfile.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_tacacs_profile(description=None, id=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create TACACSProfile.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
name (string) – name, property of the request body.
session_attributes (object) – sessionAttributes, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_profile_by_id(id, headers=None, **query_parameters)[source]¶
Get TACACSProfile by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_tacacs_profile_by_id(id, description=None, name=None, session_attributes=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update TACACSProfile.
- Parameters
description (string) – description, property of the request body.
id (basestring) – id, property of the request body.
name (string) – name, property of the request body.
session_attributes (object) – sessionAttributes, property of the request body.
id – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_tacacs_profile_by_id(id, headers=None, **query_parameters)[source]¶
Delete TACACSProfile.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_profile_by_name(name, headers=None, **query_parameters)[source]¶
Get TACACSProfile by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tacacs_server_sequence¶
- class TacacsServerSequence[source]¶
Identity Services Engine TACACSServerSequence API (version: 3.0.0).
Wraps the Identity Services Engine TACACSServerSequence API and exposes the API as native Python methods that return native Python objects.
- get_all_tacacs_server_sequence(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TACACSServerSequence.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_tacacs_server_sequence_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TACACSServerSequence.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- create_tacacs_server_sequence(local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Create TACACSServerSequence.
- Parameters
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_delimiter (string) – prefixDelimiter, property of the request body.
prefix_strip (boolean) – prefixStrip, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
server_list (string) – serverList, property of the request body.
suffix_delimiter (string) – suffixDelimiter, property of the request body.
suffix_strip (boolean) – suffixStrip, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_server_sequence_by_id(id, headers=None, **query_parameters)[source]¶
Get TACACSServerSequence by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- update_tacacs_server_sequence_by_id(id, local_accounting=None, name=None, prefix_delimiter=None, prefix_strip=None, remote_accounting=None, server_list=None, suffix_delimiter=None, suffix_strip=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Update TACACSServerSequence.
- Parameters
local_accounting (boolean) – localAccounting, property of the request body.
name (string) – name, property of the request body.
prefix_delimiter (string) – prefixDelimiter, property of the request body.
prefix_strip (boolean) – prefixStrip, property of the request body.
remote_accounting (boolean) – remoteAccounting, property of the request body.
server_list (string) – serverList, property of the request body.
suffix_delimiter (string) – suffixDelimiter, property of the request body.
suffix_strip (boolean) – suffixStrip, property of the request body.
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_tacacs_server_sequence_by_id(id, headers=None, **query_parameters)[source]¶
Delete TACACSServerSequence.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_tacacs_server_sequence_by_name(name, headers=None, **query_parameters)[source]¶
Get TACACSServerSequence by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
telemetry_information¶
- class TelemetryInformation[source]¶
Identity Services Engine TelemetryInformation API (version: 3.0.0).
Wraps the Identity Services Engine TelemetryInformation API and exposes the API as native Python methods that return native Python objects.
- get_all_telemetry_information(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TelemetryInformation.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_telemetry_information_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all TelemetryInformation.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_telemetry_info_by_id(id, headers=None, **query_parameters)[source]¶
Get TelemetryInformation by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
threat¶
- class Threat[source]¶
Identity Services Engine Threat API (version: 3.0.0).
Wraps the Identity Services Engine Threat API and exposes the API as native Python methods that return native Python objects.
- clear_threats_and_vulnerabilities(description=None, id=None, mac_addresses=None, name=None, headers=None, payload=None, active_validation=True, **query_parameters)[source]¶
Clear threats and vulnerabilities.
- Parameters
description (string) – description, property of the request body.
id (string) – id, property of the request body.
macAddresses (list) – macAddresses, property of the request body (list of strings).
name (string) – name, property of the request body.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
payload (dict) – A JSON serializable Python object to send in the body of the Request.
active_validation (bool) – Enable/Disable payload validation. Defaults to True.
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
trust_sec_configuration¶
- class TrustSecConfiguration[source]¶
Identity Services Engine TrustSec Configuration API (version: 3.0.0).
Wraps the Identity Services Engine TrustSec Configuration API and exposes the API as native Python methods that return native Python objects.
- get_security_groups(headers=None, **query_parameters)[source]¶
🚧 getSecurityGroups.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_security_group_acls(headers=None, **query_parameters)[source]¶
🚧 getSecurityGroupAcls.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_egress_policies(headers=None, **query_parameters)[source]¶
🚧 getEgressPolicies.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_egress_matrices(headers=None, **query_parameters)[source]¶
🚧 getEgressMatrices.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
trust_sec_sxp¶
- class TrustSecSxp[source]¶
Identity Services Engine TrustSec SXP API (version: 3.0.0).
Wraps the Identity Services Engine TrustSec SXP API and exposes the API as native Python methods that return native Python objects.
- get_bindings(headers=None, **query_parameters)[source]¶
🚧 getBindings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
version¶
- class Version[source]¶
Identity Services Engine Version API (version: 3.0.0).
Wraps the Identity Services Engine Version API and exposes the API as native Python methods that return native Python objects.
- get_ise_version_and_patch(headers=None, **query_parameters)[source]¶
Get Cisco ISE Version and Patch.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
version_info¶
- class VersionInfo[source]¶
Identity Services Engine VersionInfo API (version: 3.0.0).
Wraps the Identity Services Engine VersionInfo API and exposes the API as native Python methods that return native Python objects.
- get_version_info(resource, headers=None, **query_parameters)[source]¶
Get all VersionInfo.
- Parameters
resource (basestring) – resource path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
px_grid_node¶
- class PxGridNode[source]¶
Identity Services Engine pxGridNode API (version: 3.0.0).
Wraps the Identity Services Engine pxGridNode API and exposes the API as native Python methods that return native Python objects.
- get_all_px_grid_node(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all pxGridNode.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_all_px_grid_node_generator(page=None, size=None, headers=None, **query_parameters)[source]¶
Get all pxGridNode.
- Parameters
page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- A generator object containing the following object.
- RestResponse: REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
Generator
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_px_grid_node_by_id(id, headers=None, **query_parameters)[source]¶
Get pxGridNode by Id.
- Parameters
id (basestring) – id path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_px_grid_node_by_name(name, headers=None, **query_parameters)[source]¶
Get pxGridNode by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- delete_px_grid_node_by_name(name, headers=None, **query_parameters)[source]¶
Delete pxGridNode by name.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- approve_px_grid_node(name, headers=None, **query_parameters)[source]¶
Approve pxGrid Node.
- Parameters
name (basestring) – name path parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
px_grid_settings¶
- class PxGridSettings[source]¶
Identity Services Engine pxGridSettings API (version: 3.0.0).
Wraps the Identity Services Engine pxGridSettings API and exposes the API as native Python methods that return native Python objects.
- autoapprove_px_grid_node(headers=None, **query_parameters)[source]¶
Auto approve pxgridsettings.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
tasks¶
- class Tasks[source]¶
Identity Services Engine tasks API (version: 3.0.0).
Wraps the Identity Services Engine tasks API and exposes the API as native Python methods that return native Python objects.
- get_task_status(headers=None, **query_parameters)[source]¶
get all task status.
- Parameters
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(list): A list of MyDict objects. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
- get_task_status_by_id(task_id, headers=None, **query_parameters)[source]¶
Monitor task status.
- Parameters
task_id (basestring) – taskId path parameter. The id of the task executed before.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).
- Returns
- REST response with following properties:
headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation
or the bracket notation.
content(bytes): representation of the request’s response
text(str): representation of the request’s response
- Return type
- Raises
TypeError – If the parameter types are incorrect.
MalformedRequest – If the request body created is invalid.
ApiError – If the Identity Services Engine cloud returns an error.
Identity Services Engine Data Object¶
MyDict¶
- class MyDict[source]¶
A Python _dict_ subclass which tries to act like JavaScript objects, so you can use the dot notation (.) to access members of the object. If the member doesn’t exist yet then it’s created when you assign something to it. Brackets notation (d[‘foo’]) is also possible.
RestResponse¶
- class RestResponse[source]¶
RestResponse to represent the response of the calls to the Identity Services Engine APIs.
- property content¶
The content (bytes) of the RestResponse.
- property text¶
The text (str) of the RestResponse.
- property response¶
The response (MyDict) of the RestResponse.
- property headers¶
The headers (MyDict) of the RestResponse.
Exceptions¶
- exception ciscoisesdkException[source]¶
Bases:
Exception
Base class for all ciscoisesdk package exceptions.
- exception AccessTokenError[source]¶
Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Raised when an incorrect Identity Services Engine Access Token has been provided.
- exception VersionError[source]¶
Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Raised when an incorrect Identity Services Engine version has been provided.
- exception ApiError[source]¶
Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Errors returned in response to requests sent to the Identity Services Engine APIs.
Several data attributes are available for inspection.
- response¶
The
requests.Response
object returned from the API call.
- request¶
The
requests.PreparedRequest
of the API call.
- status_code¶
The HTTP status code from the API response.
- status¶
The HTTP status from the API response.
- details¶
The parsed JSON details from the API response.
- details_str¶
The text from the API response.
- message¶
The error message from the parsed API response.
- description¶
A description of the HTTP Response Code from the API docs.
- exception RateLimitError[source]¶
Bases:
ciscoisesdk.exceptions.ApiError
Identity Services Engine Rate-Limit exceeded Error.
Raised when a rate-limit exceeded message is received and the request will not be retried.
- retry_after¶
The Retry-After time period (in seconds) provided by Identity Services Engine.
Defaults to 15 seconds if the response Retry-After header isn’t present in the response headers, and defaults to a minimum wait time of 1 second if Identity Services Engine returns a Retry-After header of 0 seconds.
- exception RateLimitWarning[source]¶
Bases:
UserWarning
Identity Services Engine rate-limit exceeded warning.
Raised when a rate-limit exceeded message is received and the request will be retried.
- retry_after¶
The Retry-After time period (in seconds) provided by Identity Services Engine.
Defaults to 15 seconds if the response Retry-After header isn’t present in the response headers, and defaults to a minimum wait time of 1 second if Identity Services Engine returns a Retry-After header of 0 seconds.
- exception MalformedRequest[source]¶
Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Raised when a malformed request is received from Identity Services Engine user.
- exception DownloadFailure[source]¶
Bases:
ciscoisesdk.exceptions.ciscoisesdkException
Errors returned in response to requests sent to the Identity Services Engine APIs with stream=True.
Several data attributes are available for inspection.
- response¶
The
requests.Response
object returned from the API call.
- request¶
The
requests.PreparedRequest
of the API call.
- status_code¶
The HTTP status code from the API response.
- status¶
The HTTP status from the API response.
- original_error¶
The original exception
- raw¶
The raw value of the API response
Copyright (c) 2021 Cisco and/or its affiliates.