Rename fron onprem to fqdnip

Author: ofiriluz

ark_sdk_python/examples/requests/uap_sia_vm_add_policy_request.json

@@ -50,7 +50,7 @@
     "idleTime": 1
   },
   "targets": {
-    "onpremResource": {
+    "fqdnipResource": {
       "fqdnRules": [
         {
           "operator": "EXACTLY",

ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_access_policy.py

@@ -13,8 +13,8 @@
 from ark_sdk_python.models.services.uap.sia.vm.ark_uap_sia_vm_targets import (
     ArkUAPSIAVMAWSResource,
     ArkUAPSIAVMAzureResource,
+    ArkUAPSIAVMFQDNIPResource,
     ArkUAPSIAVMGCPResource,
-    ArkUAPSIAVMOnPremResource,
     ArkUAPSIAVMPlatformTargets,
 )
 
@@ -40,9 +40,9 @@ def serialize_model(self, *args, **kwargs) -> Dict[str, Any]:
             data['targets'] = {
                 'GCP': self.targets.gcp_resource.model_dump(*args, **kwargs),
             }
-        elif self.metadata.policy_entitlement.location_type == ArkWorkspaceType.FQDN_IP and self.targets.onprem_resource:
+        elif self.metadata.policy_entitlement.location_type == ArkWorkspaceType.FQDN_IP and self.targets.fqdnip_resource:
             data['targets'] = {
-                'FQDN/IP': self.targets.onprem_resource.model_dump(*args, **kwargs),
+                'FQDN/IP': self.targets.fqdnip_resource.model_dump(*args, **kwargs),
             }
         else:
             raise ValueError('Unsupported workspace type')
@@ -65,7 +65,7 @@ def deserialize_model(data: Dict[str, Any], *args, **kwargs) -> 'ArkUAPSIAVMAcce
             elif policy.metadata.policy_entitlement.location_type == ArkWorkspaceType.GCP and 'GCP' in data['targets']:
                 policy.targets.gcp_resource = ArkUAPSIAVMGCPResource.model_validate(data['targets']['GCP'])
             elif policy.metadata.policy_entitlement.location_type == ArkWorkspaceType.FQDN_IP and 'FQDN/IP' in data['targets']:
-                policy.targets.onprem_resource = ArkUAPSIAVMOnPremResource.model_validate(data['targets']['FQDN/IP'])
+                policy.targets.fqdnip_resource = ArkUAPSIAVMFQDNIPResource.model_validate(data['targets']['FQDN/IP'])
             else:
                 raise ValueError('Workspace type not found')
         if 'behavior' in data:

ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_targets.py

@@ -110,9 +110,9 @@ class ArkUAPSIAVMGCPResource(ArkCamelizedModel):
     projects: List[str] = Field(description='GCP project IDs. Leave empty for all projects.')
 
 
-class ArkUAPSIAVMOnPremResource(ArkCamelizedModel):
+class ArkUAPSIAVMFQDNIPResource(ArkCamelizedModel):
     """
-    Represents the on-premises resources for a virtual machine access policy, including FQDN and IP rules.
+    Represents the fqdn/ip resources for a virtual machine access policy, including FQDN and IP rules.
     """
 
     fqdn_rules: Optional[List[ArkUAPSIAVMFQDNRule]] = Field(default=None, description='List of FQDN rules applied to the connection')
@@ -128,11 +128,11 @@ class ArkUAPSIAVMPlatformTargets(ArkCamelizedModel):
         Optional[ArkUAPSIAVMAWSResource], Field(description='The AWS resource for this virtual machine access policy')
     ] = None
     azure_resource: Annotated[
-        Optional[ArkUAPSIAVMAzureResource], Field(description='The AWS resource for this virtual machine access policy')
+        Optional[ArkUAPSIAVMAzureResource], Field(description='The Azure resource for this virtual machine access policy')
     ] = None
     gcp_resource: Annotated[
-        Optional[ArkUAPSIAVMGCPResource], Field(description='The AWS resource for this virtual machine access policy')
+        Optional[ArkUAPSIAVMGCPResource], Field(description='The GCP resource for this virtual machine access policy')
     ] = None
-    onprem_resource: Annotated[
-        Optional[ArkUAPSIAVMOnPremResource], Field(description='The AWS resource for this virtual machine access policy')
+    fqdnip_resource: Annotated[
+        Optional[ArkUAPSIAVMFQDNIPResource], Field(description='The FQDN/IP resource for this virtual machine access policy')
     ] = None

ark_sdk_python/models/services/uap/utils/ark_uap_policies_workspace_type_serializer.py

@@ -11,8 +11,6 @@ def serialize_uap_policies_workspace_type(ws_type: ArkWorkspaceType) -> str:
         return 'Azure'
     elif ws_type == ArkWorkspaceType.GCP:
         return 'GCP'
-    elif ws_type == ArkWorkspaceType.ONPREM:
-        return 'OnPrem'
     elif ws_type == ArkWorkspaceType.FQDN_IP:
         return 'FQDN/IP'
     raise ArkException('Invalid Policies Workspace Type')

docs/howto/uap/uap_vm_policy_cli_workflow.md

@@ -81,7 +81,7 @@ Here is an example workflow for adding a UAP VM policy via the CLI:
         "idleTime": 1
       },
       "targets": {
-        "onpremResource": {
+        "fqdnipResource": {
           "fqdnRules": [
             {
               "operator": "EXACTLY",

docs/howto/uap/uap_vm_policy_sdk_workflow.md

@@ -54,7 +54,7 @@ uap_vm_service.add_policy(ArkUAPSIAVMAccessPolicy(
                                             domain_ephemeral_user=ArkUAPSSIAVMDomainEphemeralUser(
                                                 assign_groups=['rdp_users'], enable_ephemeral_user_reconnect=False, assign_domain_groups=['domain_rdp_users'])
                                         )),
-        targets=ArkUAPSIAVMPlatformTargets(onprem_resource=ArkUAPSIAVMOnPremResource(
+        targets=ArkUAPSIAVMPlatformTargets(fqdnip_resource=ArkUAPSIAVMFQDNIPResource(
                 fqdn_rules=[ArkUAPSIAVMFQDNRule(operator=ArkSIAVMFQDNOperator.EXACTLY, computername_pattern='myvm.mydomain.com',
                                                 domain='domain.com')],
                 ip_rules=[ArkUAPSIAVMIPRule(operator=ArkSIAVMFQDNOperator.EXACTLY, ip_addresses=['8.8.8.8'], logical_name='myLogicalName')],

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ark-sdk-python"
-version = "2.1.0"
+version = "2.1.1"
 description='Official Ark SDK / CLI for CyberArk Identity Security Platform'
 authors = ["CyberArk <[email protected]>", "Ofir Iluz <[email protected]"]
 readme = "README.md"