Skip to content

ConfigurationTemplatesApi.md

Latest commit

 

History

History
315 lines (212 loc) · 10.4 KB

ConfigurationTemplatesApi.md

File metadata and controls

315 lines (212 loc) · 10.4 KB

opal_security.ConfigurationTemplatesApi

All URIs are relative to https://api.opal.dev/v1

Method HTTP request Description
create_configuration_template POST /configuration-templates
delete_configuration_template DELETE /configuration-templates/{configuration_template_id}
get_configuration_templates GET /configuration-templates
update_configuration_template PUT /configuration-templates

create_configuration_template

ConfigurationTemplate create_configuration_template(create_configuration_template_info)

Creates a configuration template.

Example

  • Bearer Authentication (BearerAuth):
import opal_security
from opal_security.models.configuration_template import ConfigurationTemplate
from opal_security.models.create_configuration_template_info import CreateConfigurationTemplateInfo
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ConfigurationTemplatesApi(api_client)
    create_configuration_template_info = opal_security.CreateConfigurationTemplateInfo() # CreateConfigurationTemplateInfo | 

    try:
        api_response = api_instance.create_configuration_template(create_configuration_template_info)
        print("The response of ConfigurationTemplatesApi->create_configuration_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigurationTemplatesApi->create_configuration_template: %s\n" % e)

Parameters

Name Type Description Notes
create_configuration_template_info CreateConfigurationTemplateInfo

Return type

ConfigurationTemplate

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The configuration template just created. -

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

delete_configuration_template

delete_configuration_template(configuration_template_id)

Deletes a configuration template.

Example

  • Bearer Authentication (BearerAuth):
import opal_security
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ConfigurationTemplatesApi(api_client)
    configuration_template_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the configuration template.

    try:
        api_instance.delete_configuration_template(configuration_template_id)
    except Exception as e:
        print("Exception when calling ConfigurationTemplatesApi->delete_configuration_template: %s\n" % e)

Parameters

Name Type Description Notes
configuration_template_id UUID The ID of the configuration template.

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The configuration template was successfully deleted. -

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

get_configuration_templates

PaginatedConfigurationTemplateList get_configuration_templates()

Returns a list of ConfigurationTemplate objects.

Example

  • Bearer Authentication (BearerAuth):
import opal_security
from opal_security.models.paginated_configuration_template_list import PaginatedConfigurationTemplateList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ConfigurationTemplatesApi(api_client)

    try:
        api_response = api_instance.get_configuration_templates()
        print("The response of ConfigurationTemplatesApi->get_configuration_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigurationTemplatesApi->get_configuration_templates: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PaginatedConfigurationTemplateList

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 One page worth of configuration templates for your organization. -

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

update_configuration_template

ConfigurationTemplate update_configuration_template(update_configuration_template_info)

Update a configuration template.

Example

  • Bearer Authentication (BearerAuth):
import opal_security
from opal_security.models.configuration_template import ConfigurationTemplate
from opal_security.models.update_configuration_template_info import UpdateConfigurationTemplateInfo
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ConfigurationTemplatesApi(api_client)
    update_configuration_template_info = opal_security.UpdateConfigurationTemplateInfo() # UpdateConfigurationTemplateInfo | Configuration template to be updated

    try:
        api_response = api_instance.update_configuration_template(update_configuration_template_info)
        print("The response of ConfigurationTemplatesApi->update_configuration_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigurationTemplatesApi->update_configuration_template: %s\n" % e)

Parameters

Name Type Description Notes
update_configuration_template_info UpdateConfigurationTemplateInfo Configuration template to be updated

Return type

ConfigurationTemplate

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The configuration template just updated. -

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