config package

Submodules

config.app_space module

config.app_space.create_app_space(self, customer_id, name, display_name, description='')

create new AppSpace :param self: :param customer_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :return: deserialized CreateApplicationSpaceResponse

config.app_space.delete_app_space(self, app_space_id, etag)

delete an AppSpace :param self: :param app_space_id: string gid id :param etag: string :return: DeleteApplicationSpaceResponse

config.app_space.read_app_space_by_id(self, app_space_id)

get AppSpace object from id :param self: :param app_space_id: string gid id :return: AppSpace object

config.app_space.read_app_space_by_name(self, customer_id, app_space_name)

get AppSpace object from name :param self: :param customer_id: string gid id :param app_space_name: string :return: AppSpace object

config.app_space.list_app_spaces(self, customer_id, match=[])

list AppSpaces which match exact name in match param :param self: :param customer_id: string gid id :param match: list of strings :return: ListApplicationSpacesResponse object

config.app_space.update_app_space(self, app_space_id, etag, display_name, description='')

update existing AppSpace :param self: :param app_space_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateApplicationSpaceResponse

config.application module

config.application.create_application(self, app_space_id, name, display_name, description='')

create an Application :param self: :param app_space_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :return: deserialized CreateApplicationResponse

config.application.delete_application(self, application_id, etag)

delete an application :param self: :param application_id: string gid id :param etag: string :return: DeleteApplicationResponse

config.application.read_application_by_id(self, application_id)

get an Application object with an id :param self: :param application_id: string gid id :return: Application object

config.application.read_application_by_name(self, app_space_id, application_name)

get an Application object with a name :param self: :param app_space_id: string gid id :param application_name: string :return: Application object

config.application.list_applications(self, app_space_id, match=[])

list App which match exact name in match param :param self: :param app_space_id: string gid id :param match: list of strings :return: ListApplicationResponse object

config.application.update_application(self, application_id, etag, display_name, description='')

update existing Application :param self: :param application_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateApplicationResponse

config.application_agent module

config.application_agent.create_application_agent(self, application_id, name, display_name, description='')

create an AppAgent :param self: :param application_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :return: deserialized CreateApplicationAgentResponse

config.application_agent.delete_application_agent(self, application_agent_id, etag)

delete an AppAgent :param self: :param application_agent_id: string gid id :param etag: string :return: DeleteApplicationResponse

config.application_agent.read_application_agent_by_id(self, application_agent_id)

get an ApplAgent object with an id :param self: :param application_agent_id: string gid id :return: ApplicationAgent object

config.application_agent.read_application_agent_by_name(self, app_space_id, application_agent_name)

get an ApplAgent object with a name :param self: :param app_space_id: string gid id :param application_agent_name: string :return: AppAgent object

config.application_agent.list_application_agents(self, app_space_id, match=[])

list App which match exact name in match param :param self: :param app_space_id: string gid id :param match: list of strings :return: ListApplicationAgentResponse object

config.application_agent.update_application_agent(self, application_agent_id, etag, display_name, description='')

update existing AppAgent :param self: :param application_agent_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateApplicationAgentResponse

config.application_agent_credential module

config.application_agent_credential.delete_application_agent_credential(self, application_agent_credential_id, etag)

delete AppAgent credentials :param self: :param application_agent_credential_id: string gid id :param etag: string :return: DeleteApplicationAgentCredentialResponse

config.application_agent_credential.read_application_agent_credential(self, application_agent_credential_id)

Parameters:

• self –

• application_agent_credential_id – string gid id

Returns:

Application AgentCredential object

config.application_agent_credential.register_application_agent_credential_jwk(self, application_agent_id, display_name, jwk_in_bytes, expire_time_in_seconds, -)

register jwk credentials for your AppAgent :param self: :param application_agent_id: string gid id :param display_name: string :param jwk_in_bytes: bytes :param expire_time_in_seconds: int :return: deserialized RegisterApplicationAgentCredential

config.application_agent_credential.register_application_agent_credential_pem(self, application_agent_id, display_name, pem_in_bytes, expire_time_in_seconds, -)

register pem credentials for your AppAgent :param self: :param application_agent_id: string gid id :param display_name: string :param pem_in_bytes: bytes :param expire_time_in_seconds: int :return:

config.config_node module

config.config_node.authorization_policy_config(self, policy, status, tags=[])

create AuthorizationPolicyConfig :param self: :param policy: JSON string format :param status: AuthorizationPolicyConfig.Status :param tags: list of strings :return: AuthorizationPolicyConfig object

config.config_node.create_authorization_policy_config_node(self, location, name, display_name, description, authorization_policy_config)

create authorization policy :param self: :param location: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :param authorization_policy_config: AuthorizationPolicyConfig object :return: deserialized CreateConfigNode instance

config.config_node.delete_config_node(self, config_node_id, etag)

delete a specific config node :param self: :param config_node_id: string gid id :param etag: etag :return: DeleteConfigNodeResponse object

config.config_node.read_config_node(self, config_node_id)

read a specific config node :param self: :param config_node_id: string gid id :return: deserialized ConfigNode instance

config.config_node.update_authorization_policy_config_node(self, config_node_id, etag, display_name, description, authorization_policy_config)

update authorization policy :param self: :param config_node_id: string gid id :param etag: string :param display_name: string :param description: string :param authorization_policy_config: AuthorizationPolicyConfig object :return: deserialized UpdateConfigNode instance

config.config_node.validate_authorization_policy_status(self, status)

validate status :param self: :param status: string :return: True if valid or raises error

config.config_node.validate_conveyance(self, conveyance)

validate conveyance :param self: :param conveyance: string :return: True if valid or raises error

config.config_node.validate_user_verification(self, user_verification_requirement)

validate user verification requirement :param self: :param user_verification_requirement: string :return: True if valid or raises error

config.create_application_with_agent_credentials module

config.create_application_with_agent_credentials.create_application_with_agent_credentials(self, app_space_id, -, application_name, application_agent_name, application_agent_credentials_name, public_key_type, public_key=None, expire_time=None)

create application, application agent and application credentials in an appSpace :param self: :param app_space_id: string :param application_name: string :param application_agent_name: string :param application_agent_credentials_name: string :param public_key_type: jwk | pem :param public_key: bytes | None :param expire_time: int (number of seconds from now) | None :return:

config.customer module

config.customer.read_customer_by_id(self, customer_id)

get Customer object from customer id :param self: :param customer_id: string gid id :return: Customer object

config.customer.read_customer_by_name(self, customer_name)

get Customer object from customer name :param self: :param customer_name: string :return: Customer object

config.helper module

config.helper.change_display_to_name(display)

config.helper.create_agent_jwt(credentials)

config.helper.create_jwt_message(credentials)

config.helper.create_property_batch_operations(value_dict)

config.helper.create_property_mask(fields)

config.helper.get_int_from_datetime(dt)

config.helper.load_credentials(path)

config.helper.load_json(content)

config.helper.remove_accent_chars_regex(x: str)

config.service_account module

config.service_account.create_service_account(self, customer_id, name, display_name, description='', role='')

create a service account :param self: :param customer_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :param role: string :return: deserialized CreateServiceAccount instance

config.service_account.delete_service_account(self, service_account_id, etag)

delete a service account :param self: :param service_account_id: string gid id :param etag: string :return: DeleteServiceAccountResponse

config.service_account.read_service_account(self, service_account=None)

get info on existing service account from its id or from credentials :param self: :param service_account: string gid id :return: deserialized ServiceAccount instance

config.service_account.read_service_account_by_name(self, customer_id, service_account_name)

get service account info from its name :param self: :param customer_id: string gid id :param service_account_name: string :return: deserialized ServiceAccount instance

config.service_account.update_service_account(self, service_account_id, etag, display_name, description='')

update a service account :param self: :param service_account_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateServiceAccount instance

config.service_account_credential module

config.service_account_credential.delete_service_account_credential(self, service_account_credential_id, etag)

delete service account credentials :param self: :param service_account_credential_id: string gid id :param etag: string :return: DeleteServiceAccountCredentialResponse

config.service_account_credential.read_service_account_credential(self, service_account_credential_id)

read info about service account :param self: :param service_account_credential_id: string gid id :return: deserialized ServiceAccountCredential instance

config.service_account_credential.register_service_account_credential_jwk(self, service_account_id, display_name, jwk_in_bytes, expire_time_in_seconds)

register jwk credentials for your service account :param self: :param service_account_id: string gid id :param display_name: string :param jwk_in_bytes: bytes :param expire_time_in_seconds: int :return: deserialized RegisterServiceAccountCredential instance

config.service_account_credential.register_service_account_credential_pem(self, service_account_id, display_name, pem_in_bytes, expire_time_in_seconds)

register pem credentials for your service account :param self: :param service_account_id: string gid id :param display_name: string :param pem_in_bytes: bytes :param expire_time_in_seconds: int :return: deserialized RegisterServiceAccountCredential instance

Module contents

class config.ConfigClient(local=False)

Bases: object

authorization_policy_config(policy, status, tags=[])

create AuthorizationPolicyConfig :param self: :param policy: JSON string format :param status: AuthorizationPolicyConfig.Status :param tags: list of strings :return: AuthorizationPolicyConfig object

create_app_space(customer_id, name, display_name, description='')

create new AppSpace :param self: :param customer_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :return: deserialized CreateApplicationSpaceResponse

create_application(app_space_id, name, display_name, description='')

create an Application :param self: :param app_space_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :return: deserialized CreateApplicationResponse

create_application_agent(application_id, name, display_name, description='')

create an AppAgent :param self: :param application_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :return: deserialized CreateApplicationAgentResponse

create_application_with_agent_credentials(app_space_id, -, application_name, application_agent_name, application_agent_credentials_name, public_key_type, public_key=None, expire_time=None)

create application, application agent and application credentials in an appSpace :param self: :param app_space_id: string :param application_name: string :param application_agent_name: string :param application_agent_credentials_name: string :param public_key_type: jwk | pem :param public_key: bytes | None :param expire_time: int (number of seconds from now) | None :return:

create_authorization_policy_config_node(location, name, display_name, description, authorization_policy_config)

create authorization policy :param self: :param location: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :param authorization_policy_config: AuthorizationPolicyConfig object :return: deserialized CreateConfigNode instance

create_service_account(customer_id, name, display_name, description='', role='')

create a service account :param self: :param customer_id: string gid id :param name: string pattern: ^[a-z](?:[-a-z0-9]{0,61}[a-z0-9])$ :param display_name: string :param description: string :param role: string :return: deserialized CreateServiceAccount instance

delete_app_space(app_space_id, etag)

delete an AppSpace :param self: :param app_space_id: string gid id :param etag: string :return: DeleteApplicationSpaceResponse

delete_application(application_id, etag)

delete an application :param self: :param application_id: string gid id :param etag: string :return: DeleteApplicationResponse

delete_application_agent(application_agent_id, etag)

delete an AppAgent :param self: :param application_agent_id: string gid id :param etag: string :return: DeleteApplicationResponse

delete_application_agent_credential(application_agent_credential_id, etag)

delete AppAgent credentials :param self: :param application_agent_credential_id: string gid id :param etag: string :return: DeleteApplicationAgentCredentialResponse

delete_config_node(config_node_id, etag)

delete a specific config node :param self: :param config_node_id: string gid id :param etag: etag :return: DeleteConfigNodeResponse object

delete_service_account(service_account_id, etag)

delete a service account :param self: :param service_account_id: string gid id :param etag: string :return: DeleteServiceAccountResponse

delete_service_account_credential(service_account_credential_id, etag)

delete service account credentials :param self: :param service_account_credential_id: string gid id :param etag: string :return: DeleteServiceAccountCredentialResponse

read_app_space_by_id(app_space_id)

get AppSpace object from id :param self: :param app_space_id: string gid id :return: AppSpace object

read_app_space_by_name(customer_id, app_space_name)

get AppSpace object from name :param self: :param customer_id: string gid id :param app_space_name: string :return: AppSpace object

read_application_agent_by_id(application_agent_id)

get an ApplAgent object with an id :param self: :param application_agent_id: string gid id :return: ApplicationAgent object

read_application_agent_by_name(app_space_id, application_agent_name)

get an ApplAgent object with a name :param self: :param app_space_id: string gid id :param application_agent_name: string :return: AppAgent object

read_application_agent_credential(application_agent_credential_id)

Parameters:

• self –

• application_agent_credential_id – string gid id

Returns:

Application AgentCredential object

read_application_by_id(application_id)

get an Application object with an id :param self: :param application_id: string gid id :return: Application object

read_application_by_name(app_space_id, application_name)

get an Application object with a name :param self: :param app_space_id: string gid id :param application_name: string :return: Application object

list_app_spaces(customer_id, match=[])

list AppSpaces which match exact name in match param :param self: :param customer_id: string gid id :param match: list of strings :return: ListApplicationSpacesResponse object

list_application_agents(app_space_id, match=[])

list App which match exact name in match param :param self: :param app_space_id: string gid id :param match: list of strings :return: ListApplicationAgentResponse object

list_applications(app_space_id, match=[])

list App which match exact name in match param :param self: :param app_space_id: string gid id :param match: list of strings :return: ListApplicationResponse object

read_config_node(config_node_id)

read a specific config node :param self: :param config_node_id: string gid id :return: deserialized ConfigNode instance

read_customer_by_id(customer_id)

get Customer object from customer id :param self: :param customer_id: string gid id :return: Customer object

read_customer_by_name(customer_name)

get Customer object from customer name :param self: :param customer_name: string :return: Customer object

read_service_account(service_account=None)

get info on existing service account from its id or from credentials :param self: :param service_account: string gid id :return: deserialized ServiceAccount instance

read_service_account_by_name(customer_id, service_account_name)

get service account info from its name :param self: :param customer_id: string gid id :param service_account_name: string :return: deserialized ServiceAccount instance

read_service_account_credential(service_account_credential_id)

read info about service account :param self: :param service_account_credential_id: string gid id :return: deserialized ServiceAccountCredential instance

register_application_agent_credential_jwk(application_agent_id, display_name, jwk_in_bytes, expire_time_in_seconds, -)

register jwk credentials for your AppAgent :param self: :param application_agent_id: string gid id :param display_name: string :param jwk_in_bytes: bytes :param expire_time_in_seconds: int :return: deserialized RegisterApplicationAgentCredential

register_application_agent_credential_pem(application_agent_id, display_name, pem_in_bytes, expire_time_in_seconds, -)

register pem credentials for your AppAgent :param self: :param application_agent_id: string gid id :param display_name: string :param pem_in_bytes: bytes :param expire_time_in_seconds: int :return:

register_service_account_credential_jwk(service_account_id, display_name, jwk_in_bytes, expire_time_in_seconds)

register jwk credentials for your service account :param self: :param service_account_id: string gid id :param display_name: string :param jwk_in_bytes: bytes :param expire_time_in_seconds: int :return: deserialized RegisterServiceAccountCredential instance

register_service_account_credential_pem(service_account_id, display_name, pem_in_bytes, expire_time_in_seconds)

register pem credentials for your service account :param self: :param service_account_id: string gid id :param display_name: string :param pem_in_bytes: bytes :param expire_time_in_seconds: int :return: deserialized RegisterServiceAccountCredential instance

update_app_space(app_space_id, etag, display_name, description='')

update existing AppSpace :param self: :param app_space_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateApplicationSpaceResponse

update_application(application_id, etag, display_name, description='')

update existing Application :param self: :param application_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateApplicationResponse

update_application_agent(application_agent_id, etag, display_name, description='')

update existing AppAgent :param self: :param application_agent_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateApplicationAgentResponse

update_authorization_policy_config_node(config_node_id, etag, display_name, description, authorization_policy_config)

update authorization policy :param self: :param config_node_id: string gid id :param etag: string :param display_name: string :param description: string :param authorization_policy_config: AuthorizationPolicyConfig object :return: deserialized UpdateConfigNode instance

update_service_account(service_account_id, etag, display_name, description='')

update a service account :param self: :param service_account_id: string gid id :param etag: string :param display_name: string :param description: string :return: deserialized UpdateServiceAccount instance

validate_authorization_policy_status(status)

validate status :param self: :param status: string :return: True if valid or raises error

validate_conveyance(conveyance)

validate conveyance :param self: :param conveyance: string :return: True if valid or raises error

validate_user_verification(user_verification_requirement)

validate user verification requirement :param self: :param user_verification_requirement: string :return: True if valid or raises error