@uipath/cli 1.202.1 → 1.203.0-preview.180

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -208,11 +208,12 @@ following variables:
208
208
 
209
209
  | Variable | Description |
210
210
  | --- | --- |
211
- | `UIPATH_CLI_AUTH_TOKEN` | Access token (JWT). The server URL is derived from its `iss` claim. |
211
+ | `UIPATH_CLI_AUTH_TOKEN` | Access token — a JWT, or an opaque Personal Access Token (see below) |
212
212
  | `UIPATH_CLI_ORGANIZATION_NAME` | Organization slug |
213
213
  | `UIPATH_CLI_ORGANIZATION_ID` | Organization UUID |
214
214
  | `UIPATH_CLI_TENANT_NAME` | Tenant slug |
215
215
  | `UIPATH_CLI_TENANT_ID` | Tenant UUID |
216
+ | `UIPATH_URL` | Base URL, e.g. `https://cloud.uipath.com`. Ignored for a JWT; **required** for a PAT |
216
217
 
217
218
  **Example (GitHub Actions):**
218
219
  ```yaml
@@ -230,16 +231,111 @@ env:
230
231
  its freshness. There is no refresh flow: if the token is expired,
231
232
  `uip login status` reports `Expired` and commands fail until the
232
233
  env var is rotated.
233
- - The server URL is **not** a separate env var — it is derived from the
234
- token's `iss` claim, which is the authoritative source for the
235
- identity server that minted the token. This prevents mis-routing
236
- when a user sets `UIPATH_URL` inconsistently with the token.
234
+ - For a **JWT**, the server URL is derived from the token's `iss` claim,
235
+ which is the authoritative source for the identity server that minted
236
+ it, and `UIPATH_URL` is ignored. This prevents mis-routing when a user
237
+ sets `UIPATH_URL` inconsistently with the token. For an **opaque token**
238
+ such as a PAT there is no claim to read, so `UIPATH_URL` is required.
237
239
  - When `UIPATH_CLI_ENABLE_ENV_AUTH` is unset (or any value other than
238
240
  the literal string `true`), the file-based auth flow is used — no
239
241
  behavior change for existing users.
240
242
  - Missing or empty required variables produce a clear error naming the
241
243
  offending variable rather than a generic "not authenticated".
242
244
 
245
+ #### Personal Access Tokens (PAT)
246
+
247
+ A UiPath Personal Access Token is an opaque "reference token" tied to
248
+ your user account. UiPath services accept it directly as a bearer
249
+ credential, so the CLI performs no token exchange with it.
250
+
251
+ There is no interactive PAT login — `uip login` never prompts for or
252
+ accepts a PAT. Environment-variable auth (above) is the only way to use
253
+ one.
254
+
255
+ **Version requirement.** Authenticating with a PAT needs `uip`
256
+ **1.202.0 or later**. Earlier versions accept only a JWT in
257
+ `UIPATH_CLI_AUTH_TOKEN` and fail on an opaque token. The
258
+ `uip admin pat` management commands are older and work in 1.201.0 too —
259
+ you can mint a token there, you just cannot log in with it.
260
+
261
+ Reach for a PAT when a command needs a **user** identity. Commands that
262
+ resolve through the Resource Catalog, such as
263
+ `uip solution resources refresh`, depend on your folder roles, which an
264
+ External Application does not have — a client ID and secret fail there
265
+ even with the right scopes. For ordinary deploy and run work
266
+ (`uip solution publish`, `uip or jobs start`, assets, queues) prefer an
267
+ External Application with `uip login --client-id ... --client-secret ...`.
268
+
269
+ **Create a token:**
270
+ ```bash
271
+ # Browse the scopes you can ask for
272
+ uip admin scopes list --output table
273
+
274
+ # Scopes are comma-separated in a single argument;
275
+ # --expiration must be YYYY-MM-DD
276
+ uip admin pat create \
277
+ --description "CI deploy" \
278
+ --expiration 2027-03-31 \
279
+ --scope OR.Execution,OR.Jobs,OR.Assets
280
+ ```
281
+
282
+ The response carries the token once and it is never retrievable again:
283
+
284
+ ```json
285
+ {
286
+ "Result": "Success",
287
+ "Code": "PatCreated",
288
+ "Data": {
289
+ "Token": "<the token string>",
290
+ "Warning": "Save this token now. It will not be shown again."
291
+ }
292
+ }
293
+ ```
294
+
295
+ Manage the rest of its life with `uip admin pat list`,
296
+ `uip admin pat revoke <id>` and
297
+ `uip admin pat regenerate <id> --expiration <date>`.
298
+
299
+ **Use a token:**
300
+ ```bash
301
+ export UIPATH_CLI_ENABLE_ENV_AUTH=true
302
+ export UIPATH_CLI_AUTH_TOKEN="<your-pat>"
303
+ export UIPATH_URL="https://cloud.uipath.com"
304
+ export UIPATH_CLI_ORGANIZATION_NAME=contoso
305
+ export UIPATH_CLI_ORGANIZATION_ID=11111111-1111-1111-1111-111111111111
306
+ export UIPATH_CLI_TENANT_NAME=Default
307
+ export UIPATH_CLI_TENANT_ID=22222222-2222-2222-2222-222222222222
308
+
309
+ uip or assets list
310
+ ```
311
+
312
+ No `uip login` step is needed. To find the two UUIDs, log in
313
+ interactively once and read them from `uip login status --output json`.
314
+
315
+ **Notes:**
316
+ - `UIPATH_URL` is required here. A PAT carries no readable claims, so the
317
+ CLI cannot work out which server to call; omitting it fails with an
318
+ error naming the variable.
319
+ - **No expiry warning.** Because the token is opaque,
320
+ `uip login status` reports `Logged in` with no expiration date and no
321
+ identity fields, plus a hint saying so. Once the token expires or is
322
+ revoked, commands fail with `401` and nothing warns you first — track
323
+ the expiry date yourself.
324
+ - **No refresh.** An expired token stays expired until you replace the
325
+ variable.
326
+ - `uip login tenant set` is refused while the gate is on. Change
327
+ `UIPATH_CLI_TENANT_NAME` / `UIPATH_CLI_TENANT_ID` instead.
328
+ - In a pipeline that also logs in with client credentials, set the gate
329
+ **per step**, not globally: wherever `UIPATH_CLI_ENABLE_ENV_AUTH=true`
330
+ is set the CLI skips `.uipath/.auth`, which would take those other
331
+ steps off the session they just created.
332
+ - `uip login which` prints which auth source is in effect and which of
333
+ the five `UIPATH_CLI_*` variables are still missing — by name, never by
334
+ value, so it is safe to leave in a build log. It does not track
335
+ `UIPATH_URL`, so it reports `AllVarsPresent: true` even when a PAT is
336
+ missing its base URL; that surfaces on the first real command as a
337
+ `ConfigError` naming `UIPATH_URL`.
338
+
243
339
  #### Robot-credentials-only authentication (Studio Desktop)
244
340
 
245
341
  For consumers that spawn `uip` from a process whose user is already
@@ -5,7 +5,7 @@ compiled into its `dist/` output rather than installed alongside it.
5
5
  Their licences and copyright notices are reproduced here in full, as
6
6
  those licences require.
7
7
 
8
- 117 bundled dependencies:
8
+ 120 bundled dependencies:
9
9
 
10
10
  - @azure/abort-controller@2.2.0 — MIT
11
11
  - @azure/core-rest-pipeline@1.16.3 — MIT
@@ -26,6 +26,7 @@ those licences require.
26
26
  - @inquirer/core@11.2.1 — MIT
27
27
  - @inquirer/figures@2.0.7 — MIT
28
28
  - @inquirer/input@5.1.2 — MIT
29
+ - @inquirer/prompts@8.5.2 — MIT
29
30
  - @inquirer/select@5.2.1 — MIT
30
31
  - @microsoft/applicationinsights-web-snippet@1.0.1 — MIT
31
32
  - @modelcontextprotocol/sdk@1.29.0 — MIT
@@ -39,6 +40,8 @@ those licences require.
39
40
  - @opentelemetry/semantic-conventions@1.28.0 — Apache-2.0
40
41
  - @opentelemetry/semantic-conventions@1.28.0 — Apache-2.0
41
42
  - @typespec/ts-http-runtime@0.3.7 — MIT
43
+ - @uipath/coreipc@2.5.1-20260324-07 — MIT
44
+ - @uipath/robot-client@26.0.193-alpha22964 — MIT
42
45
  - agent-base@7.1.4 — MIT
43
46
  - agent-base@7.1.4 — MIT
44
47
  - ajv@8.20.0 — MIT
@@ -710,6 +713,40 @@ OTHER DEALINGS IN THE SOFTWARE.
710
713
 
711
714
  ---
712
715
 
716
+ ## @inquirer/prompts@8.5.2
717
+
718
+ Inlined by a bundled dependency rather than resolved directly,
719
+ so it does not appear in this package's source maps.
720
+
721
+ SPDX: MIT
722
+
723
+ ```
724
+ Copyright (c) 2025 Simon Boudrias
725
+
726
+ Permission is hereby granted, free of charge, to any person
727
+ obtaining a copy of this software and associated documentation
728
+ files (the "Software"), to deal in the Software without
729
+ restriction, including without limitation the rights to use,
730
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
731
+ copies of the Software, and to permit persons to whom the
732
+ Software is furnished to do so, subject to the following
733
+ conditions:
734
+
735
+ The above copyright notice and this permission notice shall be
736
+ included in all copies or substantial portions of the Software.
737
+
738
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
739
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
740
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
741
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
742
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
743
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
744
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
745
+ OTHER DEALINGS IN THE SOFTWARE.
746
+ ```
747
+
748
+ ---
749
+
713
750
  ## @inquirer/select@5.2.1
714
751
 
715
752
  SPDX: MIT
@@ -2721,6 +2758,26 @@ SOFTWARE.
2721
2758
 
2722
2759
  ---
2723
2760
 
2761
+ ## @uipath/coreipc@2.5.1-20260324-07
2762
+
2763
+ SPDX: MIT
2764
+
2765
+ The upstream package ships no licence file here; `MIT` is the
2766
+ licence it is distributed under. The canonical text of that licence
2767
+ applies, with copyright held by the package's authors.
2768
+
2769
+ ---
2770
+
2771
+ ## @uipath/robot-client@26.0.193-alpha22964
2772
+
2773
+ SPDX: MIT
2774
+
2775
+ The upstream package ships no licence file here; `MIT` is the
2776
+ licence it is distributed under. The canonical text of that licence
2777
+ applies, with copyright held by the package's authors.
2778
+
2779
+ ---
2780
+
2724
2781
  ## agent-base@7.1.4
2725
2782
 
2726
2783
  SPDX: MIT
@@ -3226,9 +3283,9 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
3226
3283
 
3227
3284
  SPDX: MIT
3228
3285
 
3229
- The upstream package ships no licence file; `MIT` is the
3230
- licence declared in its `package.json`. The canonical text of that
3231
- licence applies, with copyright held by the package's authors.
3286
+ The upstream package ships no licence file here; `MIT` is the
3287
+ licence it is distributed under. The canonical text of that licence
3288
+ applies, with copyright held by the package's authors.
3232
3289
 
3233
3290
  ---
3234
3291
 
@@ -3296,9 +3353,9 @@ SOFTWARE.
3296
3353
 
3297
3354
  SPDX: BSD-2-Clause
3298
3355
 
3299
- The upstream package ships no licence file; `BSD-2-Clause` is the
3300
- licence declared in its `package.json`. The canonical text of that
3301
- licence applies, with copyright held by the package's authors.
3356
+ The upstream package ships no licence file here; `BSD-2-Clause` is the
3357
+ licence it is distributed under. The canonical text of that licence
3358
+ applies, with copyright held by the package's authors.
3302
3359
 
3303
3360
  ---
3304
3361
 
@@ -1,9 +1,9 @@
1
1
  import {
2
2
  runNode
3
- } from "./index-9d17sa6t.js";
4
- import"./index-v5cj0bhj.js";
5
- import"./index-vmj27s6h.js";
6
- import"./index-tqczrxct.js";
3
+ } from "./index-szrenqr6.js";
4
+ import"./index-vmn69waj.js";
5
+ import"./index-mtdmza3c.js";
6
+ import"./index-7pvwjzsq.js";
7
7
  import"./index-g8ck9tv6.js";
8
8
  import"./index-hrt7fpkk.js";
9
9
  import"./index-d3w0wn6k.js";