{"id":19977782,"url":"https://github.com/uipath/orchestrator-powershell","last_synced_at":"2025-05-04T03:30:57.131Z","repository":{"id":40886931,"uuid":"126460156","full_name":"UiPath/orchestrator-powershell","owner":"UiPath","description":"UiPath Orchestrator PowerShell cmdlet library","archived":false,"fork":false,"pushed_at":"2023-07-07T21:41:36.000Z","size":2184,"stargazers_count":111,"open_issues_count":27,"forks_count":56,"subscribers_count":97,"default_branch":"develop","last_synced_at":"2025-04-08T02:45:21.436Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UiPath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-23T09:07:41.000Z","updated_at":"2025-03-06T05:01:38.000Z","dependencies_parsed_at":"2024-11-13T03:29:46.667Z","dependency_job_id":"fdf31dd4-e7ed-4ce5-bbde-cb95d9ebf257","html_url":"https://github.com/UiPath/orchestrator-powershell","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Forchestrator-powershell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Forchestrator-powershell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Forchestrator-powershell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Forchestrator-powershell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UiPath","download_url":"https://codeload.github.com/UiPath/orchestrator-powershell/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252283570,"owners_count":21723498,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:29:15.360Z","updated_at":"2025-05-04T03:30:52.122Z","avatar_url":"https://github.com/UiPath.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UiPath Orchestrator PowerShell library\n\nA PowerShell library for interacting with [UiPath Orchestrator](https://orchestrator.uipath.com/).\n\n```PowerShell\nPS C:\\\u003eInstall-PackageProvider -Name NuGet -Force\nPS C:\\\u003eRegister-PSRepository -Name UiPath -SourceLocation https://www.myget.org/F/uipath-dev/api/v2\nPS C:\\\u003eInstall-Module -Repository UiPath -Name UiPath.Powershell -Force\nPS C:\\\u003eImport-Module UiPath.PowerShell\n```\n\n# Login to UiPath Automation Cloud using interactive login\n```\nPS C:\\\u003eGet-UiPathAuthToken -Session\n```\n\n# Login to UiPath Automation Cloud using API keys\n```\nPS C:\\\u003eGet-UiPathAuthToken -Session -ClientId \u003cyour_client_id\u003e -UserKey \u003cyour_user_key\u003e\n```\n\n#Login to your on-premise deployed Orchestrator\n```\nPS C:\\\u003eGet-UiPathAuthToken -Session -URL \u003corchestrator_url\u003e -Username \u003cusername\u003e -Password \u003cpassword\u003e\n```\n\n# Using the UiPath.PowerShell module\n\nThe full documentation is in [docs](docs/Home.md)\n\nUse the PowerShell `Get-Command` to obtain all cmdlets exported by the module:\n\n```PowerShell\nPS C:\\\u003eGet-Command -Module UiPath.PowerShell\n```\n\nYou can obtain each command syntax using PowerShell's own `Get-Help`:\n\n```PowerShell\nPS C:\\\u003eGet-Help Add-UiPathRobot\n```\n\nTo start using the library, you need to connect first to a running Orchestrator instance. Use the [`Get-UiPathAuthToken`](docs/Get-UiPathAuthToken.md) cmdlet:\n```PowerShell\nPS C:\\\u003eGet-UiPathAuthToken -URL \u003corchestratorurl\u003e -Username \u003cOrchestratorUser\u003e -Password \u003cpassword\u003e -Session\n```\n\nTo connect to an Orchestrator instance using integrated AD and SSO, use the `-WindowsCredentials` argument to obtain the token. The library will authenticate to Orchestrator as the Windows user running the PowerShell session:\n```PowerShell\nPS C:\\\u003eGet-UiPathAuthToken -URL \u003corchestratorurl\u003e -WindowsCredentials -Session\n```\n\nThe `-Session` flag makes the authentication persist on the PowerShell session for up to 30 minutes. After this you will not have to authenticate again each cmdlet. Some examples:\n\nUse `Get-UiPathAuthToken ... -TenantName \u003ctenantName\u003e` for multi-tenant Orchetsrator deployments.\nUse `Get-UiPathAuthToken ... -OrganizationUnit \u003cOUName\u003e` for Orchetsrator deployments with OrganizationUnits enabled.\n\nIf you don't specify any argument, the authentication will be an interactive authentication with the UiPath Cloud service.\n\n```PowerShell\nPS C:\\\u003e Get-UiPathRobot | Format-Table\n\n Id LicenseKey MachineName    Name           Description\n -- ---------- -----------    ----           -----------\n\n132            RERUSANU       PwdRobot1\n133            RERUSANU       PwdRobot2\n134            RERUSANU       PwdRobot3\n```\n\nFor more example, see the [docs](docs/Home.md)\n\n# Getting Started\n\n## Automated install\n\n### Register the UiPath Gallery as a NuGet module provider\n\nThe UiPath.PowerShell module can be installed as a NuGet package. You will need to run once these commands first:\n\n```PowerShell\nPS C:\\\u003eInstall-PackageProvider -Name NuGet -Force -Scope CurrentUser\nPS C:\\\u003eRegister-PSRepository -Name UiPath -SourceLocation https://www.myget.org/F/uipath-dev/api/v2\n```\n\nNote that in the example above the use of `-Scope CurrentUser` means that the NuGet package provider is registered only for the current user. This does not require administrative privilegs, but the registration is transient. You may opt instead to run from an elevated prompt and remove the `-Scope CurrentUser` for a permanent registration.\n\nYou can validate that the NuGet package provider and the UiPath Gallery repository are registered:\n\n```PowerShell\nPS C:\\\u003eGet-PackageProvider -Name NuGet\n\nName                     Version          DynamicOptions\n----                     -------          --------------\nNuGet                    2.8.5.208        Destination, ExcludeVersion, Scope, SkipDependencies, Headers, FilterOnTag...\n\nPS C:\u003eGet-PSRepository\n\nName                      InstallationPolicy   SourceLocation\n----                      ------------------   --------------\nPSGallery                 Untrusted            https://www.powershellgallery.com/api/v2\nUiPath                    Untrusted            https://www.myget.org/F/uipath-dev/api/v2\n````\n\n### Install the UiPath.PowerShell module using the UiPath repository\n\n```PowerShell\nPS C:\\\u003eInstall-Module -Repository UiPath -Name UiPath.Powershell -Force  -Scope CurrentUser\nPS C:\\\u003eImport-Module UiPath.PowerShell\n```\n\nThis command will download, install and import the UiPath.PowerShell module. Again, you can opt to use a global scope by removing the `-Scope CurrentUser` argument, but this will require running the command an elevated prompt.\n\nYou can validate that the module was downloaded, installed and loaded:\n```PowerShell\nPS c:\\\u003eGet-Module UiPath.PowerShell\n\nModuleType Version    Name                                ExportedCommands\n---------- -------    ----                                ----------------\nBinary     18.3.2.... UiPath.PowerShell                   {Add-UiPathAsset, Add-UiPathEnvironment, Add-UiPathEnviron...\n\n```\n\n### Manual Install\n\nDownload the package from https://www.myget.org/feed/uipath-dev/package/nuget/UiPath.PowerShell, extract the content, and then run:\n\n```PowerShell\nPS c:\\\u003eImport-Module UiPath.PowerShell.dll\n```\n\n# License\n\nThis project is copyright [UiPath INC](https://uipath.com) and licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n\n# Prerequisites for building from source\n\nTo build the project, In addition to the C# SDK (the solution is Visual Studio 2017 based) you will need [autorest](https://github.com/Azure/autorest).\nTo use the library you won't need anything but the build artifacts.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Forchestrator-powershell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuipath%2Forchestrator-powershell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Forchestrator-powershell/lists"}