• Overview
• Getting Started
  • Prerequisites
  • Installation
  • Quick Start
• Authentication
  • Authentication Methods
  • SDK Initialization
  • OAuth Integration Patterns
• Usage
• Samples
• Development

const sdk = new UiPath({
  baseUrl: 'https://cloud.uipath.com',
  orgName: 'your-organization',
  tenantName: 'your-tenant',
  clientId: 'your-client-id',
  redirectUri: 'your-redirect-uri',
  scope: 'your-scopes'
});

// IMPORTANT: OAuth requires calling initialize()
await sdk.initialize();

const sdk = new UiPath({
  baseUrl: 'https://cloud.uipath.com',
  orgName: 'your-organization',
  tenantName: 'your-tenant',
  secret: 'your-secret' //PAT Token or Bearer Token 
});

The initialize() method completes the authentication process for the SDK:

• Secret Authentication: Auto-initializes when creating the SDK instance - no need to call initialize()
• OAuth Authentication: MUST call await sdk.initialize() before using any SDK services

Example: Secret Authentication (Auto-initialized)

const sdk = new UiPath({
  baseUrl: 'https://cloud.uipath.com',
  orgName: 'your-organization',
  tenantName: 'your-tenant',
  secret: 'your-secret' //PAT Token or Bearer Token 
});

// Ready to use immediately - no initialize() needed
const tasks = await sdk.tasks.getAll();

Example: OAuth Authentication (Requires initialize)

const sdk = new UiPath({
  baseUrl: 'https://cloud.uipath.com',
  orgName: 'your-organization',
  tenantName: 'your-tenant',
  clientId: 'your-client-id',
  redirectUri: 'http://localhost:3000',
  scope: 'your-scopes'
});

// Must initialize before using services
try {
  await sdk.initialize();
  console.log('SDK initialized successfully');
  
  // Now you can use the SDK
  const tasks = await sdk.tasks.getAll();
} catch (error) {
  console.error('Failed to initialize SDK:', error);
}

Auto-login on App Load

useEffect(() => {
  const initSDK = async () => {
    const sdk = new UiPath({...oauthConfig});
    await sdk.initialize();
  };
  initSDK();
}, []);

User-Triggered Login

const onLogin = async () => {
  await sdk.initialize();
};

// Handle OAuth callback
const oauthCompleted = useRef(false);
useEffect(() => {
  if (sdk.isInitialized() && !oauthCompleted.current) {
    oauthCompleted.current = true;
    sdk.completeOAuth();
  }
}, []);

Available OAuth Methods

• sdk.initialize() - Start OAuth flow (auto completes also based on callback state)
• sdk.isInitialized() - Check if SDK initialization completed
• sdk.isAuthenticated() - Check if user has valid token
• sdk.isInOAuthCallback() - Check if processing OAuth redirect
• sdk.completeOAuth() - Manually complete OAuth (advanced use)

// Maestro - Get processes and their instances
const processes = await sdk.maestro.processes.getAll();
const instances = await sdk.maestro.processes.instances.getAll({
  processKey: 'my-process',
  pageSize: 10
});

// Control Process Instances
await sdk.maestro.processes.instances.pause(instanceId, 'folder-key');
await sdk.maestro.processes.instances.resume(instanceId, 'folder-key');
await sdk.maestro.processes.instances.cancel(instanceId, 'folder-key', {
  comment: 'Cancelled due to error'
});

// Maestro Case Instances
const caseInstance = await sdk.maestro.cases.instances.getById(instanceId, 'folder-key');
const stages = await sdk.maestro.cases.instances.getStages(instanceId, 'folder-key');

// Control Case Instances
await sdk.maestro.cases.instances.close(instanceId, 'folder-key', {
  comment: 'Case resolved successfully'
});

// Orchestrator Processes - Start a process
const result = await sdk.processes.start({
  processKey: 'MyProcess_Key',
}, folderId);

// Tasks - Create, assign, and complete
const task = await sdk.tasks.create({
  title: 'Review Invoice',
  priority: 'High'
}, folderId);

await sdk.tasks.assign({
  taskId: task.id,
  userNameOrEmail: '[email protected]'
}, folderId);

await sdk.tasks.complete(TaskType.App, {
  taskId: task.id,
  data: {},
  action: 'submit'
}, folderId);

// Buckets - File operations
const bucket = await sdk.buckets.getById(bucketId, folderId);
const fileMetadata = await sdk.buckets.getFileMetaData(bucketId, folderId, {
  prefix: '/invoices/'
});

// Upload file
await sdk.buckets.uploadFile({
  bucketId: bucketId,
  folderId: folderId,
  prefix: '/folder1'
});

// Get download URL
const downloadUrl = await sdk.buckets.getReadUri({
  bucketId: bucketId,
  folderId: folderId,
  path: '/folder/file.pdf'
});

// Data Fabric Entities - CRUD operations
const entity = await sdk.entities.getById('entity-uuid');
const records = await sdk.entities.getRecordsById('entity-uuid', {
  pageSize: 100,
  expansionLevel: 1
});

// Insert records
await sdk.entities.insertById('entity-uuid', [
  { name: 'John Doe', email: '[email protected]', status: 'Active' },
  { name: 'Jane Smith', email: '[email protected]', status: 'Active' }
]);

// Update records
await sdk.entities.updateById('entity-uuid', [
  { Id: 'record-id-1', status: 'Inactive' }
]);

// Delete records
await sdk.entities.deleteById('entity-uuid', ['record-id-1', 'record-id-2']);