UIP o roles

Sintaxis y opciones para `uip o roles`, que gestiona los roles, permisos y asignaciones a nivel de carpeta de Orchestrator RBAC.

uip or roles manages Orchestrator roles and permissions (RBAC). Roles bundle permissions and are assigned to users, groups, robots, machines, or external applications at either the tenant (globally) or folder (scoped) level. Verbs on this page cover roles and their permissions, role-user membership, principal-level role/permission inspection, and folder-level assignments. For tenant-level role assignment per user, see users assign-roles in uip or users.

Sinopsis

uip or roles permissions list [options]
uip or roles list [options]
uip or roles get <role-key>
uip or roles create --name <name> --type <Tenant|Folder>
uip or roles update <role-key> [--add-permissions <names>] [--remove-permissions <names>]
uip or roles delete <role-key> -y
uip or roles users list <role-key> [options]
uip or roles users set <role-key> [--add-user-keys <keys>] [--remove-user-keys <keys>]
uip or roles user-roles list <principal-name> [--type <type>] [options]
uip or roles user-permissions list <username> [--folder-path <path> | --folder-key <key>]
uip or roles assign --user-key <key> --role-keys <keys> [--folder-path <path> | --folder-key <key>]

Verbos

Verbo	Propósito
permissions list	Enumerar los nombres de permisos que se pueden conceder.
list	Enumera los roles en el tenant.
get	Obtener un rol con sus permisos concedidos.
create	Crea un rol (sin permisos) en el ámbito Tenant o Folder .
update (alias edit)	Añade o elimina permisos en un rol.
delete	Eliminar un rol creado por el usuario.
users list	Enumerar los usuarios asignados a un rol.
users set	Añadir o eliminar usuarios en un rol (en masa).
user-roles list	List a principal's (user, group, robot, machine, or external app) complete role assignments across tenant and every folder.
user-permissions list	List a user's effective permissions, tenant-wide or scoped to one folder.
assign	Asigna roles en el nivel de carpeta a un usuario en una carpeta específica.

uip or roles permissions list

Enumera todos los nombres de permisos que se pueden conceder. Utilice estos nombres con roles update --add-permissions.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--sort-by	Campo	Name asc	Ordenación de OData.

Ejemplos

uip or roles permissions list --limit 200
uip or roles permissions list --output-filter 'Data[].Name'
uip or roles permissions list --output table

Forma de datos (--json de salida)

{
  "Code": "PermissionList",
  "Data": [{ "Name": "Assets.Create" }, { "Name": "Assets.Delete" }]
}

uip or roles list

List roles. Returns key (GUID), ID, name, display name, type, and whether the role is editable. Use the role key with roles get, roles update, or roles users set.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--sort-by	Campo	Id desc	Ordenación de OData.

Ejemplos

uip or roles list --limit 50
uip or roles list --output-filter "Data[?Type=='Tenant'].Name"
uip or roles list --output table

Forma de datos (--json de salida)

{
  "Code": "RoleList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "ID": 1,
      "Name": "Administrator",
      "DisplayName": "Administrator",
      "Type": "Tenant",
      "IsEditable": false
    }
  ]
}

uip or roles get

Obtener un rol con sus permisos concedidos.

Argumentos

Nombre	Obligatorio	Propósito
<role-key>	Sí	Role key (GUID). Use roles list to find it.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción

Ejemplos

uip or roles get a1b2c3d4-0000-0000-0000-000000000001
uip or roles get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Permissions'
uip or roles get a1b2c3d4-0000-0000-0000-000000000001 --output table

Forma de datos (--json de salida)

{
  "Code": "Role",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "ID": 1,
    "Name": "Administrator",
    "DisplayName": "Administrator",
    "Type": "Tenant",
    "IsStatic": true,
    "IsEditable": false,
    "Permissions": "Assets.View, Assets.Create, Jobs.View"
  }
}

uip or roles create

Cree un rol sin permisos. Después de la creación, concede permisos con roles update --add-permissions.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--name	text	obligatorio	Nombre del rol.
—	--type	Tenant | Folder	obligatorio	Tenant applies across the tenant; Folder applies within folders.

Ejemplos

uip or roles create --name "Read Only" --type Tenant
uip or roles create --name "Folder Viewer" --type Folder
uip or roles create --name "Read Only" --type Tenant \
    --output-filter 'Data.Key'

Forma de datos (--json de salida)

{
  "Code": "RoleCreated",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "ID": 10,
    "Name": "Read Only",
    "Type": "Tenant",
    "Status": "Created successfully"
  }
}

uip or roles update

Añade o elimina permisos en un rol. Lee los permisos actuales, alterna isGranted para los nombres en --add-permissions / --remove-permissions y guarda. Los nuevos nombres (que aún no están en el rol) se buscan en el catálogo de permisos completo del tenant y se añaden.

edit is a registered alias for this verb — uip or roles edit works identically to uip or roles update.

Argumentos

Nombre	Obligatorio	Propósito
<role-key>	Sí	Clave de rol (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--add-permissions	CSV de nombres	—	Permisos para conceder.
—	--remove-permissions	CSV de nombres	—	Permisos para revocar.

Se requiere al menos uno de --add-permissions o --remove-permissions .

Ejemplos

uip or roles update a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View,Jobs.View

uip or roles update a1b2c3d4-0000-0000-0000-000000000010 \
    --remove-permissions Jobs.Edit

uip or roles update a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "RoleUpdated",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Updated successfully" }
}

uip or roles delete

Eliminar un rol creado por el usuario. Los roles integrados (donde IsStatic=true) no se pueden eliminar.

Argumentos

Nombre	Obligatorio	Propósito
<role-key>	Sí	Clave de rol (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-y	--yes	Marca	—	Required. Confirms this irreversible operation — the CLI never prompts.

Ejemplos

uip or roles delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or roles delete a1b2c3d4-0000-0000-0000-000000000010 --yes \
    --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "RoleDeleted",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

uip or roles users list

Enumerar los usuarios asignados a un rol.

Argumentos

Nombre	Obligatorio	Propósito
<role-key>	Sí	Clave de rol (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.

Ejemplos

uip or roles users list a1b2c3d4-0000-0000-0000-000000000001
uip or roles users list a1b2c3d4-0000-0000-0000-000000000001 --limit 200
uip or roles users list a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data[].UserName'

Forma de datos (--json de salida)

{
  "Code": "RoleUserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "ID": 101,
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User"
    }
  ]
}

uip or roles users set

Add or remove users on a role (bulk). Provide --add-user-keys, --remove-user-keys, or both. At least one is required. Additive/subtractive only — existing membership not named in either flag is left untouched (unlike users assign-roles, which replaces the full list).

Argumentos

Nombre	Obligatorio	Propósito
<role-key>	Sí	Clave de rol (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--add-user-keys	CSV de GUID	—	Usuarios a añadir.
—	--remove-user-keys	CSV de GUID	—	Usuarios a eliminar.

Ejemplos

uip or roles users set a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-0000-0000-0000-000000000001

uip or roles users set a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001,d4e5f6a7-…-002 \
    --remove-user-keys d4e5f6a7-…-099

uip or roles users set a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001 --output-filter 'Data.Added'

Forma de datos (--json de salida)

{
  "Code": "RoleUsersUpdated",
  "Data": {
    "RoleKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "Added": 1,
    "Removed": 0,
    "Status": "Updated successfully"
  }
}

uip or roles user-roles list

List all role assignments for a principal — a user, directory group, directory robot, machine, or external application — across the tenant and every folder. Useful for auditing a principal's full access profile.

Argumentos

Nombre	Obligatorio	Propósito
<principal-name>	Sí	Username, group name, robot name, machine name, or external-app name to look up.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--type	User | Group | Robot | Machine | ExternalApplication	User	Principal type. The DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication spellings are also accepted as aliases.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.

Ejemplos

uip or roles user-roles list [e-mail]
uip or roles user-roles list "MRS Developers" --type Group
uip or roles user-roles list [e-mail] \
    --output-filter "Data[?Scope=='Folder']"

Forma de datos (--json de salida)

{
  "Code": "UserRoleList",
  "Data": [
    { "Scope": "Tenant", "FolderPath": "", "Role": "Administrator" },
    { "Scope": "Folder", "FolderPath": "Shared", "Role": "Folder Administrator" }
  ]
}

uip or roles user-permissions list

List a user's effective permissions. Without a folder option, shows tenant-level roles and permissions; with --folder-path/--folder-key, shows the roles and permissions granted in that specific folder instead. Returns the deduplicated union of permissions granted by all matching roles.

Argumentos

Nombre	Obligatorio	Propósito
<username>	Sí	Nombre de usuario para buscar.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	—	Show folder-level permissions for this folder instead of tenant-level.
—	--folder-key	GUID	—	Folder alternative to --folder-path.

Ejemplos

uip or roles user-permissions list [e-mail]

uip or roles user-permissions list [e-mail] --folder-path "Shared"

Forma de datos (--json de salida)

Tenant-level:

{
  "Code": "UserPermissionList",
  "Data": {
    "Roles": ["Administrator"],
    "Permissions": ["Jobs.View", "Assets.Create"]
  }
}

Folder-scoped:

{
  "Code": "UserPermissionList",
  "Data": {
    "FolderPath": "Shared",
    "Roles": ["Folder User"],
    "Permissions": ["Jobs.View", "Assets.View"]
  }
}

UIP o asignación de roles

Asigna roles en el nivel de carpeta a un usuario. Usa solo roles de tipo Carpeta. Requiere --folder-path o --folder-key.

Nota:

CAUTION — destructive on roles. The server replaces the user's entire folder-level role list for the target folder with the keys passed via --role-keys. Roles not in the payload are silently removed. To preserve existing folder roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. For additive tenant-level role membership on a role, use roles users set instead.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--user-key	GUID	obligatorio	Clave de usuario.
—	--role-keys	CSV de GUID	obligatorio	GUID de rol para asignar en la carpeta.
—	--folder-path	Ruta	—	Carpeta de destino. Proporciona esto o --folder-key.
—	--folder-key	GUID	—	Carpeta de destino.

Ejemplos

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --folder-path "Shared"

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-…-002,a1b2c3d4-…-003 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --folder-path "Shared" --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "PermissionsAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}

Códigos de salida

Consulta Códigos de salida. Sin anulaciones específicas de verbos.

Comandos relacionados

• uip or users : buscar claves de usuario; users assign-roles para asignaciones de roles en el nivel de tenant.
• uip or folders : localiza las claves de carpeta para roles assign.

Ver también

• Opciones globales.
• Autenticación.