Merge pull request #644 from UiPath/release/auth

Author: radugheo

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.1.80"
+version = "2.1.81"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

samples/asset-modifier-agent/.env.example

@@ -0,0 +1 @@
+UIPATH_CLIENT_SECRET=

samples/asset-modifier-agent/README.md

@@ -0,0 +1,112 @@
+# UiPath Coded Agent: Asset Value Checker
+
+This project demonstrates how to create a Python-based UiPath Coded Agent that connects as an External Application to UiPath Orchestrator, retrieves an asset, and validates its IntValue against custom rules.
+
+## Overview
+
+The agent uses the UiPath Python SDK to:
+
+* Connect to UiPath Orchestrator as an external application
+* Authenticate via the Client Credentials flow (Client ID + Client Secret)
+* Retrieve a specific asset from a given folder
+* Check whether the asset has an integer value and validate it against a range (100–1000)
+* Return a descriptive message with the validation result
+
+## Prerequisites
+
+* [UV package manager](https://docs.astral.sh/uv/) installed
+* UiPath Orchestrator access
+* An External Application configured in UiPath with the `OR.Assets` scope
+
+You can learn how to create and setup your own External Application from the [UiPath documentation](https://docs.uipath.com/automation-cloud/automation-cloud/latest/admin-guide/managing-external-applications).
+
+## Setup
+
+### Step 1: Create and Activate Virtual Environment
+
+```bash
+uv venv
+```
+
+Activate the virtual environment:
+- **Windows**: `.venv\Scripts\activate`
+- **Linux/Mac**: `source .venv/bin/activate`
+
+### Step 2: Install Dependencies
+
+```bash
+uv sync
+```
+
+### Step 3: Configure the Application
+
+1. **Edit `main.py`** (lines 13, 16) and replace the placeholder values:
+   - `UIPATH_CLIENT_ID`: Replace `"EXTERNAL_APP_CLIENT_ID_HERE"` with your External Application's Client ID
+   - `UIPATH_URL`: Replace `"base_url"` with your Orchestrator URL (e.g., `"https://cloud.uipath.com/your_org/your_tenant"`)
+
+2. **Set Environment Variables**
+
+   Create a `.env` file in the project directory or set the environment variable:
+   ```bash
+   UIPATH_CLIENT_SECRET=your-client-secret-here
+   ```
+
+### Step 4: Initialize the Agent
+
+```bash
+uv run uipath init
+```
+
+### Step 5: Prepare Input Data
+
+Format your `input.json` file with the following structure:
+
+```json
+{
+  "asset_name": "test-asset",
+  "folder_path": "TestFolder"
+}
+```
+
+**Input Parameters:**
+- `asset_name`: The name of the UiPath asset to validate
+- `folder_path`: The folder path in Orchestrator where the asset is located
+
+### Step 6: Run the Agent
+
+Execute the agent locally:
+
+```bash
+uipath run --input-file input.json
+```
+
+## How It Works
+
+When this agent runs, it will:
+
+1. Load input values (`asset_name` and `folder_path`)
+2. Connect to Orchestrator using Client Credentials authentication
+3. Retrieve the specified asset from the given folder
+4. Validate the asset's IntValue against the allowed range (100–1000)
+5. Return a descriptive message with the validation result
+
+**Possible Outputs:**
+- "Asset not found." — Asset doesn't exist
+- "Asset does not have an IntValue." — Asset exists but has no integer value
+- "Asset '<name>' has a valid IntValue: <value>" — IntValue is within range
+- "Asset '<name>' has an out-of-range IntValue: <value>" — IntValue is outside range
+
+## Publish Your Coded Agent
+
+Once tested locally, publish your agent to Orchestrator:
+
+1. Pack the agent:
+   ```bash
+   uipath pack
+   ```
+
+2. Publish to Orchestrator:
+   ```bash
+   uipath publish
+   ```
+

samples/asset-modifier-agent/input.json

@@ -0,0 +1,4 @@
+{
+  "asset_name": "test-asset",
+  "folder_path": "TestFolder"
+}

samples/asset-modifier-agent/main.py

@@ -0,0 +1,80 @@
+import dataclasses
+import dotenv
+import logging
+import os
+
+from typing import Optional
+from uipath import UiPath
+from uipath.tracing import traced
+
+dotenv.load_dotenv()
+logger = logging.getLogger(__name__)
+
+UIPATH_CLIENT_ID = "EXTERNAL_APP_CLIENT_ID_HERE"
+UIPATH_CLIENT_SECRET = os.getenv("UIPATH_CLIENT_SECRET")
+UIPATH_SCOPE = "OR.Assets"
+UIPATH_URL = "base_url"
+
+uipath = UiPath(
+    client_id=UIPATH_CLIENT_ID,
+    client_secret=UIPATH_CLIENT_SECRET,
+    scope=UIPATH_SCOPE,
+    base_url=UIPATH_URL
+)
+
+@dataclasses.dataclass
+class AgentInput:
+    """Input data structure for the UiPath agent.
+
+    Attributes:
+        asset_name (str): The name of the UiPath asset.
+        folder_path (str): The folder path where the asset is located.
+    """
+    asset_name: str
+    folder_path: str
+
+def get_asset(name: str, folder_path: str) -> Optional[object]:
+    """Retrieve an asset from UiPath.
+
+    Args:
+        name (str): The asset name.
+        folder_path (str): The UiPath folder path.
+
+    Returns:
+        Optional[object]: The asset object if found, else None.
+    """
+    return uipath.assets.retrieve(name=name, folder_path=folder_path)
+
+def check_asset(asset: object) -> str:
+    """Check if an asset's IntValue is within a valid range.
+
+    Args:
+        asset (object): The asset object.
+
+    Returns:
+        str: Result message depending on asset state.
+    """
+    if asset is None:
+        return "Asset not found."
+
+    int_value = getattr(asset, "int_value", None)
+    if int_value is None:
+        return "Asset does not have an IntValue."
+
+    if 100 <= int_value <= 1000:
+        return f"Asset '{asset.name}' has a valid IntValue: {int_value}"
+    else:
+        return f"Asset '{asset.name}' has an out-of-range IntValue: {int_value}"
+
+@traced()
+def main(input: AgentInput) -> str:
+    """Main entry point for the agent.
+
+    Args:
+        input (AgentInput): The input containing asset details.
+
+    Returns:
+        str: Message with the result of the asset check.
+    """
+    asset = get_asset(input.asset_name, input.folder_path)
+    return check_asset(asset)

samples/asset-modifier-agent/pyproject.toml

@@ -0,0 +1,9 @@
+[project]
+name = "asset-checker-agent"
+version = "0.0.1"
+description = "UiPath agent to validate asset values via External Application integration with Orchestrator."
+authors = [{ name = "John Doe", email = "john.doe@myemail.com" }]
+dependencies = [
+    "uipath>=2.1.45",
+]
+requires-python = ">=3.10"