Skip to content

Latest commit

 

History

History
647 lines (435 loc) · 21.6 KB

ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi.md

File metadata and controls

647 lines (435 loc) · 21.6 KB

openapi_client.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi

All URIs are relative to /dataservice

Method HTTP request Description
create_policy_definition6 POST /template/policy/definition/vpnmembershipgroup
delete_policy_definition6 DELETE /template/policy/definition/vpnmembershipgroup/{id}
edit_multiple_policy_definition6 PUT /template/policy/definition/vpnmembershipgroup/multiple/{id}
edit_policy_definition6 PUT /template/policy/definition/vpnmembershipgroup/{id}
get_definitions6 GET /template/policy/definition/vpnmembershipgroup
get_policy_definition6 GET /template/policy/definition/vpnmembershipgroup/{id}
preview_policy_definition6 POST /template/policy/definition/vpnmembershipgroup/preview
preview_policy_definition_by_id6 GET /template/policy/definition/vpnmembershipgroup/preview/{id}
save_policy_definition_in_bulk6 PUT /template/policy/definition/vpnmembershipgroup/bulk

create_policy_definition6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition6()

Create policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.create_policy_definition6(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->create_policy_definition6: %s\n" % e)

Parameters

Name Type Description Notes
body {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Policy definition [optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_policy_definition6

delete_policy_definition6(id)

Delete policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_instance.delete_policy_definition6(id)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->delete_policy_definition6: %s\n" % e)

Parameters

Name Type Description Notes
id str Policy Id

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_multiple_policy_definition6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition6(id)

Edit multiple policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.edit_multiple_policy_definition6(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_multiple_policy_definition6: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.edit_multiple_policy_definition6(id, body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_multiple_policy_definition6: %s\n" % e)

Parameters

Name Type Description Notes
id str Policy Id
body {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Policy definition [optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_policy_definition6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition6(id)

Edit a policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.edit_policy_definition6(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_policy_definition6: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.edit_policy_definition6(id, body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->edit_policy_definition6: %s\n" % e)

Parameters

Name Type Description Notes
id str Policy Id
body {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Policy definition [optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_definitions6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions6()

Get policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.get_definitions6()
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->get_definitions6: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_policy_definition6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition6(id)

Get a specific policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_policy_definition6(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->get_policy_definition6: %s\n" % e)

Parameters

Name Type Description Notes
id str Policy Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preview_policy_definition6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition6()

Preview policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.preview_policy_definition6(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->preview_policy_definition6: %s\n" % e)

Parameters

Name Type Description Notes
body {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Policy definition [optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preview_policy_definition_by_id6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id6(id)

Preview policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.preview_policy_definition_by_id6(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->preview_policy_definition_by_id6: %s\n" % e)

Parameters

Name Type Description Notes
id str Policy Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

save_policy_definition_in_bulk6

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk6()

Create/Edit policy definitions in bulk

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_vpn_membership_group_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_vpn_membership_group_definition_builder_api.ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.save_policy_definition_in_bulk6(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyVPNMembershipGroupDefinitionBuilderApi->save_policy_definition_in_bulk6: %s\n" % e)

Parameters

Name Type Description Notes
body {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Policy definition [optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]