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 gestiona los roles y permisos de Orchestrator (RBAC). Los roles agrupan los permisos y se asignan a usuarios, grupos, robots, máquinas o aplicaciones externas en el nivel de tenant (globalmente) o de carpeta (ámbito). Los verbos de esta página cubren los roles y sus permisos, la membresía de rol-usuario, la inspección de roles/permisos a nivel de director y las asignaciones a nivel de carpeta. Para la asignación de roles en el nivel de tenant por usuario, consulta users assign-roles en 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	Enumera las asignaciones de roles completas de un director (usuario, grupo, robot, máquina o aplicación externa) en el tenant y en cada carpeta.
user-permissions list	Enumera los permisos efectivos de un usuario, en todo el tenant o en el ámbito de una carpeta.
assign	Asigna roles en el nivel de carpeta a un usuario en una carpeta específica.

lista de permisos de uip o roles

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 o lista de roles

Enumerar roles. Devuelve la clave (GUID), ID, nombre, nombre para mostrar, tipo y si el rol es editable. Utiliza la clave de rol con roles get, roles update o 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 o roles get

Obtener un rol con sus permisos concedidos.

Argumentos

Nombre	Obligatorio	Propósito
<role-key>	Sí	Clave de rol (GUID). Usa roles list para encontrarlo.

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 o creación de roles

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 se aplica en todo el tenant; Folder se aplica dentro de las carpetas.

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"
  }
}

actualización de uip o roles

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 es un alias registrado para este verbo: uip or roles edit funciona de forma idéntica a 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" }
}

eliminar uip o roles

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	—	Obligatorio. Confirma esta operación irreversible: la CLI nunca solicita.

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" }
}

lista de usuarios de uip o roles

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 o roles establecidos por los usuarios

Añadir o eliminar usuarios en un rol (en bloque). Proporcione --add-user-keys, --remove-user-keys o ambos. Se requiere al menos uno. Solo aditivo/sustractivo: la membresía existente no nombrada en ninguno de los marcadores se deja intacta (a diferencia de users assign-roles, que reemplaza la lista completa).

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"
  }
}

lista de roles de usuario de uip o roles

Enumera todas las asignaciones de roles para un director (un usuario, grupo de directorio, robot de directorio, máquina o aplicación externa) en el tenant y en cada carpeta. Útil para auditar el perfil de acceso completo de un director.

Argumentos

Nombre	Obligatorio	Propósito
<principal-name>	Sí	Nombre de usuario, nombre de grupo, nombre de robot, nombre de máquina o nombre de aplicación externa para buscar.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--type	User | Group | Robot | Machine | ExternalApplication	User	Tipo principal. Las grafías DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication también se aceptan como alias.
-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" }
  ]
}

lista de permisos de usuario de uip o roles

Enumerar los permisos efectivos de un usuario. Sin una opción de carpeta, muestra los roles y permisos a nivel de tenant; con --folder-path/--folder-key, muestra los roles y permisos concedidos en esa carpeta específica. Devuelve la unión deduplicada de permisos concedidos por todos los roles coincidentes.

Argumentos

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

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	—	Mostrar permisos a nivel de carpeta para esta carpeta en lugar de a nivel de tenant.
—	--folder-key	GUID	—	Carpeta alternativa a --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)

Nivel de tenant:

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

Ámbito de carpeta:

{
  "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:

PRECAUCIÓN: destructivo en los roles. El servidor reemplaza toda la lista de roles a nivel de carpeta del usuario para la carpeta de destino con las claves pasadas a través de --role-keys. Los roles que no están en la carga útil se eliminan de forma silenciosa. Para conservar los roles de carpeta existentes, léelos primero con roles user-roles list <principal-name> --type <type> y pasa la unión completa deseada a --role-keys. Para la membresía de rol a nivel de tenant en un rol, utiliza roles users set en su lugar.

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.