- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip insights users
Syntax and options for `uip insights users`, which reads the Insights users of the active tenant and their Insights role names.
uip insights users reads the tenant users visible to the current caller, along with their Insights role names. This is a read-only surface — there is no create, update, or delete verb.
Reading Insights users requires the Insights Management View permission in the active tenant. A session with no user identity (for example, one signed in with client credentials) cannot read this data at all and gets a 403.
Synopsis
uip insights users list [--include-email] [-l <n>] [-o <n>]
uip insights users get <user-id> [--include-email]
uip insights users list [--include-email] [-l <n>] [-o <n>]
uip insights users get <user-id> [--include-email]
Both verbs honor the global options and the standard exit codes. Neither accepts -t, --tenant — they use the tenant selected during uip login.
uip insights users list
List tenant users visible to the current caller, with their Insights role names.
Options
| Flag | Description |
|---|---|
--include-email | Include email addresses and the nested role IDs in the output. Off by default — the default view omits both. |
-l, --limit <number> | Maximum rows to return. Defaults to 50. |
-o, --offset <number> | Rows to skip before returning results. |
Pagination is client-side: the backend returns the full unpaginated list, and the CLI slices it after fetching.
Examples
uip insights users list
uip insights users list --include-email --limit 100
uip insights users list
uip insights users list --include-email --limit 100
Data shape — default view
{
"Code": "InsightsUsersList",
"Data": [
{
"id": "b2c3d4e5-0000-0000-0000-000000000001",
"name": "Jane Doe",
"roles": [{ "name": "Viewer" }]
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false },
"Instructions": "Roles shown are the user's Insights roles in the active tenant, by name; 'uip insights roles list' maps a role name to its role GUID and back. A user's row is kept even when directory enrichment fails. This view omits email and the nested role IDs. Pass --include-email to include them."
}
{
"Code": "InsightsUsersList",
"Data": [
{
"id": "b2c3d4e5-0000-0000-0000-000000000001",
"name": "Jane Doe",
"roles": [{ "name": "Viewer" }]
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false },
"Instructions": "Roles shown are the user's Insights roles in the active tenant, by name; 'uip insights roles list' maps a role name to its role GUID and back. A user's row is kept even when directory enrichment fails. This view omits email and the nested role IDs. Pass --include-email to include them."
}
Data shape — with --include-email
{
"Code": "InsightsUsersList",
"Data": [
{
"id": "b2c3d4e5-0000-0000-0000-000000000001",
"name": "Jane Doe",
"roles": [{ "id": "c1d2e3f4-0000-0000-0000-000000000001", "name": "Viewer" }],
"email": "[email protected]"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false }
}
{
"Code": "InsightsUsersList",
"Data": [
{
"id": "b2c3d4e5-0000-0000-0000-000000000001",
"name": "Jane Doe",
"roles": [{ "id": "c1d2e3f4-0000-0000-0000-000000000001", "name": "Viewer" }],
"email": "[email protected]"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false }
}
With --include-email, Instructions carries the same note without its last two sentences. A user's row is kept in the list even when directory enrichment (resolving display data) fails for that user — an incomplete row is not dropped.
uip insights users get
Get one Insights user by its GUID.
Arguments
| Name | Required | Purpose |
|---|---|---|
<user-id> | yes | User GUID. A value that isn't a GUID fails client-side with Run 'uip insights users list' to find a user ID. before any network call. |
Options
| Flag | Description |
|---|---|
--include-email | Include the email address and the nested role IDs in the output. Off by default. |
Example
uip insights users get b2c3d4e5-0000-0000-0000-000000000001
uip insights users get b2c3d4e5-0000-0000-0000-000000000001
Data shape (--output json)
{
"Code": "InsightsUserGet",
"Data": { "id": "b2c3d4e5-0000-0000-0000-000000000001", "name": "Jane Doe", "roles": [{ "name": "Viewer" }] }
}
{
"Code": "InsightsUserGet",
"Data": { "id": "b2c3d4e5-0000-0000-0000-000000000001", "name": "Jane Doe", "roles": [{ "name": "Viewer" }] }
}
With --include-email, the same shape gains email and the nested roles[].id, same as the list view. As in the list, the user's name can be blank or out of date when directory enrichment fails.
A 404 fails with User <id> was not found in the active Insights tenant, or is not visible there. The same user can exist in another tenant. If every Insights RBAC command returns 404, the tenant may not have the Insights Portal service provisioned.
See also
- Insights overview
- roles, groups — the other RBAC read surfaces;
rolesmaps the role names shown here to their GUIDs and back. - alerts, alert-history — other tenant-scoped read surfaces.