UIP es la autenticación del creador de conectores

Sintaxis y opciones para configurar e inspeccionar el esquema de autenticación de un conector con el creador de conectores de Integration Service: conjunto de autenticación, obtención de autenticación y creación/lista del sistema de autenticación.

Esta página cubre uip is connectors builder auth, el grupo de comandos que define el propio esquema de autenticación de un conector: cómo el propio conector se comunica con la API de su proveedor. Esta es una preocupación de tiempo de diseño, distinta de una conexión de tenant, que es una instancia de runtime de ese esquema (las credenciales de un usuario específico contra el esquema que configura esta página). Para la resolución del directorio del conector, la distinción entre diseño y publicado y el flujo general de creación, consulta Conceptos en la página principal.

Sinopsis

uip is connectors builder auth set --auth-type <type> [scheme-specific options] [--connector-dir <path>]
uip is connectors builder auth get [--connector-dir <path>]
uip is connectors builder auth system create --type <type> [--vendor-path <path>] [--method <method>] [--next-resource <selector>] [--path <path>] [--connector-dir <path>]
uip is connectors builder auth system list [--connector-dir <path>]

Ninguna de estas opciones tiene ámbito de tenant: no hay ningún marcador --tenant en ningún lugar de este grupo. Todo aquí edita o lee solo el directorio del conector local.

UIP es un conjunto de autenticación del creador de conectores

Configura la autenticación en el conector. Se --auth-type requiere uno; cuál de las opciones restantes se aplica depende de ese tipo. Volver a ejecutarse en un conector ya configurado falla a menos que se pase --force, que aplica la diferencia a las entradas de configuración existentes en lugar de errores: esto existe porque se puede rechazar un primer intento (por ejemplo, un cambio de opciones de ámbito que entra en conflicto con configuración existente) y debe volver a intentarse.

Nota:

Úsalo para conectar la autenticación en un conector existente, para cualquiera de los siguientes tipos de autenticación, o para intercambiar el tipo de autenticación de un conector existente (--force). Define los ámbitos de OAuth/JWT aquí también, a través de --scope-options/--required-scopes/--preselected-scopes — no hay un comando auth scope independiente. No utilices esto para crear un conector desde cero: utiliza builder init primero. No utilices esto para entradas de configuración que no sean de autenticación: utiliza builder init preset apply o builder state patch (consulta Desencadenador y estado).

Opciones

Largo	Valor	SeAplicaA	Descripción
--auth-type <type>	uno de los siguientes tipos	todo	Obligatorio. El flujo de autenticación que se va a configurar.
--connector-dir <path>	Ruta	todo	Directorio del conector. Mismo orden de resolución que Conceptos.
--force	Marca	todo	Aplicar diferencias a las entradas de configuración existentes en lugar de generar errores cuando el conector ya está configurado.
--authorization-url <url>	url	OAuth	URL de inicio de sesión/consentimiento.
--token-url <url>	url	OAuth, JWT	Punto final del token.
--token-refresh-url <url>	url	OAuth	Es --token-url de forma predeterminada.
--token-revoke-url <url>	url	OAuth	Punto final de revocación del token.
--scope <scope>	String	OAuth, JWT, firstPartyService	Cadena de ámbito delimitada por espacios. Para firstPartyService, el ámbito de la plataforma que lleva el token acuñado.
--jwt-claim <spec>	name[=value][;label=...][;hint=...], repetible	jwtOauth, jwtOauth2	Reclamación de aserción JWT. Se crea un nombre simple (sin =value) requerido y vacío para que el usuario de la conexión lo rellene en el momento de la conexión; label/hint establece el nombre para mostrar del formulario de conexión y el texto de la sugerencia.
--jwt-header <spec>	Misma sintaxis que --jwt-claim, repetible	jwtOauth, jwtOauth2	Encabezado de aserción JWT.
--aws-service-name <name>	String	awsv4	Constante de nombre de servicio SigV4 (por ejemplo, polly, connect); establece el valor predeterminado oculto aws.service.name.
--scope-options <json>	Matriz JSON de {description, value}	OAuth, JWT	Opciones de ámbito de selección múltiple ofrecidas al usuario de conexión.
--scope-options-file <path>	Ruta	OAuth, JWT	Leer --scope-options JSON de un archivo en lugar de en línea.
--required-scopes <csv>	separados por comas	OAuth, JWT	Ámbitos que el usuario no puede deseleccionar.
--preselected-scopes <csv>	separados por comas	OAuth, JWT	Ámbitos precomprobados de forma predeterminada.
--scope-delimiter <char>	String	OAuth, JWT	Separador de ámbito. Predeterminado: espacio.
--scope-hint-text <text>	String	OAuth, JWT	Texto de sugerencia que se muestra debajo del selector de ámbito.
--scope-screen-type <type>	String	OAuth, JWT	configScreenType para la entrada de ámbito. Predeterminado: pre.
--api-key-param-name <name>	String	customApiKey	Nombre del parámetro de consulta o encabezado del proveedor obligatorio.
--api-key-location <where>	header | query	customApiKey	A dónde se envía la clave. Predeterminado: header.
--api-key-prefix <prefix>	String	customApiKey	Prefijo literal antepuesto al valor de la clave.
--key-config-name <key>	String	customApiKey	Clave de configuración interna. Predeterminado: custom.api.key.
--key-config-display-name <name>	String	customApiKey	Etiqueta de IU. Predeterminado: API Key.
--validation-vendor-path <path>	Ruta	todos (opcional)	Añada una llamada de prueba provisionAuthValidation en la ruta de este proveedor.
--validation-method <method>	Método HTTP	todos (opcional)	Método para la llamada de validación de autenticación. Predeterminado y recomendado: GET — la sonda debe ser de solo lectura y no debe cambiar los datos del proveedor.
--auth-header <kv>	ConfigName=VendorHeader, repetible	esquemas de encabezado múltiple	Encabezado de autenticación estático adicional, creado como una configuración de texto sin formato que rellena el usuario de conexión. Para esquemas que necesitan más de un encabezado de credencial (por ejemplo, API-AppId/API-Username de iContact).
--secret-auth-header <kv>	ConfigName=VendorHeader, repetible	esquemas de encabezado múltiple	Como --auth-header, pero la configuración se crea como un campo de contraseña cifrado. Para encabezados de credenciales como API-Password.

--auth-type acepta uno de: oauth2, oauth2Pkce, oauth2ClientCredentials, oauth2Password, oauth2PrivateKeyJwt, oauth1, basic, jwtOauth, jwtOauth2, custom, customApiKey, personalAccessToken, awsv4, googleServiceAccount, rsaCertificate, none, firstPartyService, fpsUserDelegatedAccess, fpsRobotAccess.

firstPartyService es la identidad inyectada en la plataforma UiPath: la plataforma acuña y actualiza el token, vinculando {host}/{account}/{tenant} a los encabezados de la plataforma en lugar de a los campos de configuración de tiempo de conexión (esos tres campos en realidad se eliminan de la configuración establecido al cambiar a este tipo, como se muestra en el siguiente ejemplo).

Cada tipo de autenticación escribe un paquete de configuración diferente: los siguientes ejemplos muestran un resultado real específico del tipo en lugar de una forma genérica.

Ejemplos

# OAuth2 authorization-code flow
uip is connectors builder auth set --auth-type oauth2 \
  --authorization-url https://acme.com/oauth/authorize \
  --token-url https://acme.com/oauth/token \
  --scope 'read write'

{
  "Code": "AuthConfigured",
  "Data": {
    "AuthType": "oauth2",
    "AuthenticationTypes": ["oauth2"],
    "TypeOauth": true,
    "OauthRefreshResourceCreated": true,
    "ConfigChanges": {
      "added": ["oauth.api.key", "oauth.api.secret", "oauth.token.url"],
      "updated": [],
      "unchanged": []
    }
  }
}

# customApiKey, sent as a header
uip is connectors builder auth set --auth-type customApiKey --api-key-param-name X-API-Key

{
  "Code": "AuthConfigured",
  "Data": {
    "AuthType": "customApiKey",
    "AuthenticationTypes": ["customApiKey"],
    "TypeOauth": false,
    "ApiKeyConfigAdded": true,
    "ApiKeyParamAdded": true,
    "KeyConfigName": "custom.api.key",
    "ConfigChanges": { "added": ["custom.api.key"], "updated": [], "unchanged": [] }
  }
}

# Re-apply a config diff that was rejected on first try
uip is connectors builder auth set --auth-type customApiKey --api-key-param-name X-API-Key --force

{
  "Code": "AuthConfigured",
  "Data": {
    "AuthType": "customApiKey",
    "ConfigChanges": {
      "added": [],
      "updated": [{ "key": "custom.api.key", "diff": { "displayOrder": [3, 1] } }],
      "unchanged": []
    }
  }
}

# OAuth 2.0 JWT Bearer (Salesforce-style): claims with a value are pre-filled,
# bare claims are filled in by the connection user
uip is connectors builder auth set --auth-type jwtOauth \
  --token-url https://login.salesforce.com/services/oauth2/token \
  --jwt-claim aud=https://login.salesforce.com \
  --jwt-claim iss \
  --jwt-claim sub

{
  "Code": "AuthConfigured",
  "Data": {
    "AuthType": "jwtOauth",
    "AuthenticationTypes": ["jwtOauth"],
    "TypeOauth": true,
    "ConfigChanges": {
      "added": [
        "oauth.api.key", "oauth.api.secret", "oauth.callback.url", "oauth.token.url",
        "jwt.base64.encoded.key", "jwt.claim.aud", "jwt.claim.iss", "jwt.claim.sub"
      ],
      "updated": [],
      "unchanged": []
    }
  }
}

# UiPath first-party service auth (platform-injected identity)
uip is connectors builder auth set --auth-type firstPartyService --scope OrchestratorApiUserAccess

{
  "Code": "AuthConfigured",
  "Data": {
    "AuthType": "firstPartyService",
    "AuthenticationTypes": ["firstPartyService"],
    "TypeOauth": false,
    "ConfigChanges": {
      "added": [
        "oauth.scope", "oauth.basic.header", "oauth.user.token",
        "oauth.user.refresh_time", "oauth.user.refresh_interval"
      ],
      "updated": [],
      "unchanged": [],
      "removed": ["host", "account", "tenant"]
    }
  }
}

# No authentication
uip is connectors builder auth set --auth-type none

{
  "Code": "AuthConfigured",
  "Data": {
    "AuthType": "none",
    "AuthenticationTypes": ["none"],
    "TypeOauth": false,
    "ConfigChanges": { "added": [], "updated": [], "unchanged": [] }
  }
}

uip es obtener autenticación del creador de conectores

Lee la configuración de autenticación completa del conector: tipo, entradas de configuración (secretos redactados), recursos del ciclo de vida y vinculaciones de encabezado FPS.

Nota:

Utilízalo para inspeccionar el bloque de autenticación actual del conector. Para cambiarlo, utiliza auth set.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector. Mismo orden de resolución que Conceptos.

Ejemplo

uip is connectors builder auth get

Forma de datos (--json de salida)

{
  "Code": "AuthInfo",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "Authentication": {
      "Type": "jwtOauth",
      "AuthenticationTypes": ["jwtOauth"],
      "TypeOauth": true
    },
    "Configs": [
      {
        "key": "oauth.token.url",
        "configScreenType": null,
        "required": true,
        "hidden": true,
        "defaultValue": "https://login.acme.com/oauth2/token"
      },
      {
        "key": "jwt.claim.iss",
        "configScreenType": "pre",
        "required": true,
        "defaultValue": null
      }
    ],
    "ConnectionFormFields": [],
    "Resources": {
      "oauthOnTokenRefresh": false,
      "provisionAuthValidation": true
    },
    "FpsBindings": null,
    "TemplateBindings": null
  }
}

Los valores de configuración de tipo secreto (contraseñas, claves API) nunca se incluyen: solo los metadatos de la configuración (clave, si es obligatoria/oculta, valor predeterminado no secreto).

uip es el sistema de autenticación del creador de conectores

Gestiona los recursos del ciclo de vida del conector ("sistema"): enlaces de tiempo de autenticación como provisionAuthValidation, onProvision y oauthOnTokenRefresh. Estos se encuentran en auth porque son enlaces del ciclo de vida de autenticación: entradas element.json sin archivo SR (recurso semántico) independiente, a diferencia de un punto final de API normal creado por activity create (o un punto final ad-hoc sin SR a través de activity create --skip-sr — consulta Actividad y enganches).

uip es creación del sistema de autenticación del creador de conectores

Nota:

Úsalo para conectar un punto final de gancho de ciclo vital: autenticación-validación, onProvision o una llamada de actualización de token. No utilices esto para añadir un punto final de API normal: utiliza builder activity create en su lugar.

Opciones

Largo	Valor	Descripción
--type <type>	String	Obligatorio. Tipo de recurso del sistema, por ejemplo provisionAuthValidation, onProvision, oauthOnTokenRefresh.
--vendor-path <path>	Ruta	Ruta de la API del proveedor para este enlace.
--method <method>	Método HTTP	El valor predeterminado es POST cuando el tipo requiere un método.
--next-resource <selector>	METHOD:/path	Encadenar al siguiente recurso, por ejemplo GET:/organization.
--path <path>	Ruta	Ruta de recurso explícita: debe coincidir con la ruta de anulación del tipo cuando ese tipo declara una.
--connector-dir <path>	Ruta	Directorio del conector. Mismo orden de resolución que Conceptos.

Ejemplo

uip is connectors builder auth system create --type provisionAuthValidation --vendor-path /me

Forma de datos (--json de salida)

{
  "Code": "SystemResourceCreated",
  "Data": {
    "ResourceName": "provisionAuthValidation",
    "ConnectorRoot": "/work/my-acme-connector",
    "ResourceType": "provisionAuthValidation",
    "ElementEntriesAdded": ["provisionAuthValidation"],
    "ElementEntriesSkipped": [],
    "SkipSr": true
  }
}

uip es la lista de sistemas de autenticación del creador de conectores

Enumera las entradas de element.json del conector cuyo tipo es un recurso del sistema.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector. Mismo orden de resolución que Conceptos.

Ejemplo

uip is connectors builder auth system list

Forma de datos (--json de salida)

{
  "Code": "SystemResourceList",
  "Data": {
    "Resources": [
      { "name": "provisionAuthValidation", "type": "provisionAuthValidation" }
    ]
  }
}

Relacionado

• Descripción general y ciclo de vida del tenant : conceptos compartidos en todas las páginas del creador, más download/import/publish/publish-status.
• Inicialización y conector : aplica andamios a un conector antes de configurar su autenticación.
• Actividad y enlaces : define los puntos finales que utilizan esta autenticación una vez configurada.
• Desencadenador y estado : desencadenadores de eventos y ediciones de archivos de elementos de bajo nivel.
• uip is connections : la instancia de runtime del lado del tenant del esquema configurado aquí.

Ver también

• Descripción general de la herramienta de Integration Service
• Opciones globales
• Códigos de salida