UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

barreras de seguridad de UIP

Sintaxis y opciones para `configuraciones byo de barreras de seguridad de UIP`, que gestiona las configuraciones de barreras de seguridad propias (BYOG) para AI Trust Layer de UiPath.

uip guardrails las configuraciones de traer tu propia barrera de seguridad (BYOG) para AI Trust Layer de UiPath: conecta el propio conector de seguridad de contenido/validación de un tenant (por ejemplo, Azure AI Content Safety) en una barrera de seguridad con nombre que un agente codificado puede hacer referencia por alias . Hay un grupo de comandos, byo-configurations. Esto corresponde a Admin → AI Trust Layer → Configuraciones de barreras de seguridad en la interfaz de usuario.

Consulte uip llm-gateway para la API de descubrimiento de modelos de LLM algunos validadores de barreras de seguridad (por ejemplo LLM-como-juez).

Conceptos​

  • Configuración frente a validador. Un validador (--validator-type, p. ej. pii_detection) es una capacidad que expone un conector: descúbrelos con list-validators. Una configuración envuelve un validador con una conexión y un alias único de tenant (--validator-name) al que hace referencia la llamada ByoValidator(...) de un agente codificado; ValidatorName/ValidatorType están bloqueados en la creación, así que cambia eliminando y volviendo a crear.
  • Sondear antes de guardar. create siempre sondea primero el par de conexión/validador y aborta si el sondeo falla: no hay marca de omisión, porque el backend persiste sea cual sea el ID de conexión que se le dé sin validarlo él mismo. update solo vuelve a sondear cuando --connection-id cambia; cambiar solo --fallback-on-ui-path o el estado habilitado/deshabilitado no vuelve a sondear, por lo que una configuración cuyo proveedor está actualmente inactivo aún puede deshabilitarse.
  • --fallback-on-ui-path (predeterminado false): si se establece, una llamada BYO fallida recurre a la propia barrera de seguridad integrada de UiPath en lugar de fallar la solicitud.
  • Control de características. Si BYOG no está habilitado para el tenant, cada verbo falla con Code: "ByoGuardrailsUnavailable" y te dirige al soporte de UiPath.

Sinopsis​

uip guardrails byo-configurations list
uip guardrails byo-configurations create --connection-id <guid> --validator-name <name> --validator-type <type> [--fallback-on-ui-path] [--disabled]
uip guardrails byo-configurations update <configuration-id> [--connection-id <guid>] [--fallback-on-ui-path | --no-fallback-on-ui-path] [--enabled | --disabled]
uip guardrails byo-configurations delete <configuration-id> --force
uip guardrails byo-configurations probe --connection-id <guid> --validator-type <type>
uip guardrails byo-configurations list-validators --connection-id <guid>
uip guardrails byo-configurations list
uip guardrails byo-configurations create --connection-id <guid> --validator-name <name> --validator-type <type> [--fallback-on-ui-path] [--disabled]
uip guardrails byo-configurations update <configuration-id> [--connection-id <guid>] [--fallback-on-ui-path | --no-fallback-on-ui-path] [--enabled | --disabled]
uip guardrails byo-configurations delete <configuration-id> --force
uip guardrails byo-configurations probe --connection-id <guid> --validator-type <type>
uip guardrails byo-configurations list-validators --connection-id <guid>

Todos los verbos también aceptan --login-validity <minutes> (anulan la vigencia del token de inicio de sesión interactivo).

lista de configuraciones byo de las barreras de seguridad de uip​

Enumera las configuraciones de BYOG para el tenant autenticado, incluidos los detalles de conexión/conector.

Ejemplo​

uip guardrails byo-configurations list
uip guardrails byo-configurations list

Forma de datos (--json de salida)​

{
  "Code": "ByoGuardrailConfigurationsList",
  "Data": [
    {
      "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
      "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
      "ValidatorName": "my-pii-guardrail",
      "ValidatorType": "pii_detection",
      "FallbackOnUiPath": true,
      "Enabled": true,
      "CreatedAt": "2026-07-01T10:00:00Z",
      "UpdatedAt": null,
      "ConnectorKey": "uipath-azure-contentsafety",
      "ConnectorName": "Azure AI Content Safety",
      "ConnectionName": "My Content Safety Connection",
      "ValidConnection": true
    }
  ]
}
{
  "Code": "ByoGuardrailConfigurationsList",
  "Data": [
    {
      "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
      "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
      "ValidatorName": "my-pii-guardrail",
      "ValidatorType": "pii_detection",
      "FallbackOnUiPath": true,
      "Enabled": true,
      "CreatedAt": "2026-07-01T10:00:00Z",
      "UpdatedAt": null,
      "ConnectorKey": "uipath-azure-contentsafety",
      "ConnectorName": "Azure AI Content Safety",
      "ConnectionName": "My Content Safety Connection",
      "ValidConnection": true
    }
  ]
}

ValidatorName es el alias elegido por el tenant; ValidatorType es el ID del validador sin procesar. ValidConnection refleja si la conexión de Integration Service subyacente se resuelve actualmente.

creación de configuraciones byo de barreras de seguridad de uip​

Crea una configuración BYOG. Siempre sondea primero el par de conexión/validador (consulta Conceptos): la creación se aborta con el propio fallo de la sonda si no se aprueba.

Argumentos​

Ninguno: todo se pasa a través de opciones.

Opciones​

LargoValorObligatorioDescripción
--connection-id <guid>GUIDSíConexión de Integration Service a través de la cual llama la barrera de seguridad.
--validator-name <name>StringSíAlias único de tenant: lo que un agente codificado pasa a ByoValidator(...).
--validator-type <type>StringSíID del validador sin procesar, por ejemplo pii_detection. Descubra valores válidos con list-validators.
--fallback-on-ui-pathMarcaNoVuelve a la barrera de seguridad integrada de UiPath si la llamada BYO falla. Predeterminado false.
--disabledMarcaNoGuardar la configuración deshabilitada. El valor predeterminado está habilitado.
--login-validity <minutes>EnteroNoAnula la vigencia del token de inicio de sesión interactivo.

Ejemplo​

uip guardrails byo-configurations create \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df \
  --validator-name my-pii-guardrail --validator-type pii_detection
uip guardrails byo-configurations create \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df \
  --validator-name my-pii-guardrail --validator-type pii_detection

Forma de datos (--json de salida)​

{
  "Code": "ByoGuardrailConfigurationCreated",
  "Data": {
    "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorName": "my-pii-guardrail",
    "ValidatorType": "pii_detection",
    "FallbackOnUiPath": false,
    "Enabled": true,
    "CreatedAt": "2026-07-01T10:00:00Z",
    "UpdatedAt": null,
    "ConnectorKey": null,
    "ConnectorName": null,
    "ConnectionName": null,
    "ValidConnection": null
  }
}
{
  "Code": "ByoGuardrailConfigurationCreated",
  "Data": {
    "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010",
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorName": "my-pii-guardrail",
    "ValidatorType": "pii_detection",
    "FallbackOnUiPath": false,
    "Enabled": true,
    "CreatedAt": "2026-07-01T10:00:00Z",
    "UpdatedAt": null,
    "ConnectorKey": null,
    "ConnectorName": null,
    "ConnectionName": null,
    "ValidConnection": null
  }
}

Los campos de detalles del conector/conexión (ConnectorKey, ConnectorName, ConnectionName, ValidConnection) están null al crearse: se rellenan en list, que se une a la conexión en el momento de la lectura.

actualización de las configuraciones byo de las barreras de seguridad de UIP​

Actualizar la conexión, el comportamiento alternativo o el estado habilitado de una configuración existente. ValidatorName/ValidatorType no se puede cambiar: elimínelo y vuelva a crearlo.

Argumentos​

NombreObligatorioPropósito
<configuration-id>SíGUID de configuración de BYOG, desde list.

Opciones​

LargoValorDescripción
--connection-id <guid>GUIDNueva conexión. Vuelve a sondear el par antes de guardarlo: aborta en caso de fallo de la sonda.
--fallback-on-ui-path / --no-fallback-on-ui-pathMarcaEstablece o borra el marcador alternativo.
--enabled / --disabledMarcaMutuamente exclusivo: habilita o deshabilita la configuración.
--login-validity <minutes>EnteroAnula la vigencia del token de inicio de sesión interactivo.

Se requiere al menos uno de --connection-id, --fallback-on-ui-path/--no-fallback-on-ui-path o --enabled/--disabled; omitirlos todos falla en el lado del cliente antes de cualquier búsqueda.

Ejemplo​

uip guardrails byo-configurations update e5723bb8-fbc2-4317-c7d7-08de803bc010 \
  --connection-id 24887687-1234-4abc-9def-012345678901
uip guardrails byo-configurations update e5723bb8-fbc2-4317-c7d7-08de803bc010 \
  --connection-id 24887687-1234-4abc-9def-012345678901

Forma de datos (--json de salida)​

La misma forma que la respuesta de create, con UpdatedAt ahora establecido.

eliminación de configuraciones byo de barreras de seguridad de uip​

Eliminar de forma permanente una configuración de BYOG.

Argumentos​

NombreObligatorioPropósito
<configuration-id>SíGUID de configuración de BYOG, desde list.

Opciones​

LargoValorObligatorioDescripción
--forceMarcaSíOmite la protección de confirmación. Omitirlo falla con un error explícito "Negarse a eliminar sin --force" error: la eliminación es permanente.
--login-validity <minutes>EnteroNoAnula la vigencia del token de inicio de sesión interactivo.

Ejemplo​

uip guardrails byo-configurations delete e5723bb8-fbc2-4317-c7d7-08de803bc010 --force
uip guardrails byo-configurations delete e5723bb8-fbc2-4317-c7d7-08de803bc010 --force

Forma de datos (--json de salida)​

{ "Code": "ByoGuardrailConfigurationDeleted", "Data": { "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010" } }
{ "Code": "ByoGuardrailConfigurationDeleted", "Data": { "Id": "e5723bb8-fbc2-4317-c7d7-08de803bc010" } }

sonda byo-configurations de las barreras de seguridad de uip​

Prueba si una conexión puede servir a un validador, sin crear o guardar nada. El backend pregunta al conector por sus validadores y luego evalúa una entrada de prueba benigna utilizando los parámetros predeterminados del validador.

Opciones​

LargoValorObligatorioDescripción
--connection-id <guid>GUIDSíConexión de Integration Service para probar.
--validator-type <type>StringSíID del validador para probar. Descubrir valores con list-validators.
--login-validity <minutes>EnteroNoAnula la vigencia del token de inicio de sesión interactivo.

Ejemplo​

uip guardrails byo-configurations probe \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df --validator-type pii_detection
uip guardrails byo-configurations probe \
  --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df --validator-type pii_detection

Forma de datos (--json de salida)​

{
  "Code": "ByoGuardrailProbeSucceeded",
  "Data": {
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorType": "pii_detection",
    "ConnectorKey": "uipath-azure-contentsafety",
    "IsAvailable": true,
    "Verdict": "PASSED",
    "Details": null,
    "DurationMs": 842,
    "Error": null
  }
}
{
  "Code": "ByoGuardrailProbeSucceeded",
  "Data": {
    "ConnectionId": "18fb337c-29b7-4162-a9e8-0c05b01cf4df",
    "ValidatorType": "pii_detection",
    "ConnectorKey": "uipath-azure-contentsafety",
    "IsAvailable": true,
    "Verdict": "PASSED",
    "Details": null,
    "DurationMs": 842,
    "Error": null
  }
}

IsAvailable (no Verdict) es lo que determina el éxito/fracaso: Verdict es la evaluación del proveedor de la entrada de prueba benigna, por lo que "PASSED" y "FAILED" significan que el conector respondió. El comando sale 1 cuando IsAvailable es false, con Code: "ByoGuardrailProbeFailed" y la misma forma Data adjunta al sobre de fallo.

Barreras de seguridad de UIP byo-configurations list-validators​

Enumera los validadores que expone una conexión de Integration Service. Cada valor Validator devuelto es un --validator-type válido para probe y create.

Opciones​

LargoValorObligatorioDescripción
--connection-id <guid>GUIDSíConexión para inspeccionar.
--login-validity <minutes>EnteroNoAnula la vigencia del token de inicio de sesión interactivo.

Ejemplo​

uip guardrails byo-configurations list-validators --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df
uip guardrails byo-configurations list-validators --connection-id 18fb337c-29b7-4162-a9e8-0c05b01cf4df

Forma de datos (--json de salida)​

{
  "Code": "ByoGuardrailValidatorsList",
  "Data": [
    {
      "Validator": "pii_detection",
      "DisplayName": "PII detection",
      "Description": null,
      "Status": "Available",
      "AllowedScopes": ["Agent", "Llm", "Tool"],
      "PayloadMinSizeLimit": null,
      "PayloadMaxSizeLimit": 10000
    }
  ]
}
{
  "Code": "ByoGuardrailValidatorsList",
  "Data": [
    {
      "Validator": "pii_detection",
      "DisplayName": "PII detection",
      "Description": null,
      "Status": "Available",
      "AllowedScopes": ["Agent", "Llm", "Tool"],
      "PayloadMinSizeLimit": null,
      "PayloadMaxSizeLimit": 10000
    }
  ]
}

Comportamiento de error​

  • BYOG no está habilitado para el tenant: Code: "ByoGuardrailsUnavailable", lo que te indica el soporte de UiPath.
  • ID de configuración desconocido: Code: "ByoGuardrailConfigurationNotFound", que le indica list.
  • Un sondeo que se ejecuta correctamente pero encuentra el par inutilizable: Code: "ByoGuardrailProbeFailed", salida 1, con el resultado del sondeo aún adjunto en Data para que los scripts lo inspeccionen.
  • delete sin --force: falla antes de cualquier llamada de red.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado