UIP ist Connectors Builder-Authentifizierung

Syntax und Optionen zum Konfigurieren und Überprüfen des Authentifizierungsschemas eines Connectors mit dem Integration Service Connector-Generator – Authentifizierungssatz, Authentifizierungsabruf und Authentifizierungssystemerstellung/-liste.

Diese Seite behandelt uip is connectors builder auth, die Befehlsgruppe, die das eigene Authentifizierungsschema eines Connectors definiert – wie der Connector selbst mit seiner Anbieter-API kommuniziert. Dies ist ein Problem in der Entwurfsphase, das sich von einer Mandantenverbindung unterscheidet, die eine Runtime-Instanz dieses Schemas ist (die Anmeldeinformationen eines bestimmten Benutzers für das Schema, das auf dieser Seite konfiguriert wird). Informationen zur Connector-Verzeichnisauflösung, zur Unterscheidung zwischen Design und Veröffentlichten und zum gesamten Erstellungsablauf finden Sie unter Konzepte auf der übergeordneten Seite.

Zusammenfassung

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>]

Keine dieser Optionen ist mandantenbezogenen – es gibt kein --tenant -Flag in dieser Gruppe. Hier wird nur das lokale Connector-Verzeichnis bearbeitet oder gelesen.

uip ist Connectors Builder-Authentifizierung festgelegt

Konfigurieren Sie die Authentifizierung auf dem Connector. Ein --auth-type ist erforderlich; Welche der verbleibenden Optionen gilt, hängt vom jeweiligen Typ ab. Die erneute Ausführung für einen bereits konfigurierten Connector schlägt fehl, es sei denn, --force wird übergeben, wodurch der Unterschied auf vorhandene Konfigurationseinträge angewendet wird, anstatt einen Fehler zu verursachen – dies liegt daran, dass ein erster Versuch abgelehnt werden kann (z. B. eine Änderung der Scope-Optionen, die in Konflikt steht vorhandene Konfiguration) und muss wiederholt werden.

Hinweis:

Verwenden Sie dies, um die Authentifizierung auf einem vorhandenen Connector für einen der folgenden Authentifizierungstypen zu verknüpfen oder um den Authentifizierungstyp eines vorhandenen Connectors auszutauschen (--force). Definieren Sie OAuth/JWT-Scopes auch hier über --scope-options/--required-scopes/--preselected-scopes – es gibt keinen separaten auth scope -Befehl. Verwenden Sie dies nicht, um einen Connector von Grund auf neu zu erstellen – verwenden Sie zuerst builder init . Verwenden Sie dies nicht für Nicht-Authentifizierungs-Konfigurationseinträge – verwenden Sie builder init preset apply oder builder state patch (siehe Trigger und Status).

Optionen

Long	Wert	GiltFür	Beschreibung
--auth-type <type>	einer der folgenden Typen	Alle	Erforderlich. Der zu konfigurierende Authentifizierungsflow.
--connector-dir <path>	Pfad	Alle	Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie „Konzepte“.
--force	Markieren	Alle	Wenden Sie Unterschiede auf vorhandene Konfigurationseinträge an, anstatt einen Fehler zu verursachen, wenn der Connector bereits konfiguriert ist.
--authorization-url <url>	url	OAuth	Anmelde-/Zustimmungs-URL.
--token-url <url>	url	OAuth, JWT	Token-Endpunkt.
--token-refresh-url <url>	url	OAuth	Die Standardeinstellung ist --token-url.
--token-revoke-url <url>	url	OAuth	Endpunkt für den Tokenwiderruf.
--scope <scope>	string	OAuth, JWT firstPartyService	Durch Leerzeichen getrennte Scope-Zeichenfolge. Für firstPartyService der Plattform-Scope, den das Mining-Token mit sich bringt.
--jwt-claim <spec>	name[=value][;label=...][;hint=...], wiederholbar	jwtOauth, jwtOauth2	JWT-Assertionsanspruch. Ein leerer Name (kein =value) wird erstellt und ist leer, sodass der Verbindungsbenutzer ihn zum Zeitpunkt der Verbindung ausfüllt; label/hint Legen Sie den Anzeigenamen des Verbindungsformulars und den Hinweistext fest.
--jwt-header <spec>	Die gleiche Syntax wie --jwt-claim, wiederholbar	jwtOauth, jwtOauth2	Header der JWT-Assertion.
--aws-service-name <name>	string	awsv4	Konstante des SigV4-Dienstnamens (z. B. polly, connect); Legt den ausgeblendeten aws.service.name -Standard fest.
--scope-options <json>	JSON-Array von {description, value}	OAuth, JWT	Mehrfachauswahl für den Verbindungsbenutzer.
--scope-options-file <path>	Pfad	OAuth, JWT	Lesen Sie --scope-options -JSON aus einer Datei statt inline.
--required-scopes <csv>	durch Kommas getrennt sind	OAuth, JWT	Scopes, deren Auswahl der Benutzer nicht aufheben kann.
--preselected-scopes <csv>	durch Kommas getrennt sind	OAuth, JWT	Scopes standardmäßig vorab aktiviert.
--scope-delimiter <char>	string	OAuth, JWT	Scope-Trennzeichen. Standard: Leerzeichen.
--scope-hint-text <text>	string	OAuth, JWT	Hinweistext, der unter dem Scope-Selektor angezeigt wird.
--scope-screen-type <type>	string	OAuth, JWT	configScreenType für den Scope-Eintrag. Standard: pre.
--api-key-param-name <name>	string	customApiKey	Erforderlicher Anbieter-Header oder Abfrageparametername.
--api-key-location <where>	header | query	customApiKey	Wohin der Schlüssel gesendet wird. Standard: header.
--api-key-prefix <prefix>	string	customApiKey	Literal-Präfix vor dem Schlüsselwert.
--key-config-name <key>	string	customApiKey	Interner Konfigurationsschlüssel. Standard: custom.api.key.
--key-config-display-name <name>	string	customApiKey	UI-Beschriftung. Standard: API Key.
--validation-vendor-path <path>	Pfad	alle (optional)	Fügen Sie einen provisionAuthValidation -Testaufruf unter diesem Anbieterpfad hinzu.
--validation-method <method>	HTTP-Methode	alle (optional)	Methode für den Authentifizierungsvalidierungsaufruf. Standard und empfohlen: GET – Der Test muss schreibgeschützt sein und darf Anbieterdaten nicht ändern.
--auth-header <kv>	ConfigName=VendorHeader, wiederholbar	System mit mehreren Headern	Zusätzlicher statischer Authentifizierungsheader, der als Nur-Text-Konfiguration erstellt wurde, die der Verbindungsbenutzer ausfüllt. Für Schemas, die mehr als einen Anmeldeinformationsheader benötigen (z. B. API-AppId/API-Username von iContact).
--secret-auth-header <kv>	ConfigName=VendorHeader, wiederholbar	System mit mehreren Headern	Wie --auth-header, aber die Konfiguration wird als verschlüsseltes Kennwortfeld erstellt. Für Anmeldeinformationsheader wie API-Password.

--auth-type akzeptiert eines der folgenden Optionen: oauth2, oauth2Pkce, oauth2ClientCredentials, oauth2Password, oauth2PrivateKeyJwt, oauth1, basic, jwtOauth, jwtOauth2, custom, customApiKey, personalAccessToken, awsv4, googleServiceAccount, rsaCertificate, none, firstPartyService, fpsUserDelegatedAccess, fpsRobotAccess.

firstPartyService ist eine von der UiPath Platform hinzugefügte Identität: Die Plattform erstellt und aktualisiert das Token und bindet {host}/{account}/{tenant} an Plattformheader anstelle von Konfigurationsfeldern zur Verbindungszeit (diese drei Felder werden eigentlich aus der Konfiguration entfernt ). wenn Sie zu diesem Typ wechseln, wie im folgenden Beispiel gezeigt).

Jeder Authentifizierungstyp schreibt ein anderes Konfigurationspaket – die folgenden Beispiele zeigen jeweils ein echtes, typspezifisches Ergebnis und keine generische Form.

Beispiele

# 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 ist Connectors Builder Auth Get

Lesen Sie das vollständige Authentifizierungssetup des Connectors: Typ, Konfigurationseinträge (Geheimnisse zensiert), Lebenszyklusressourcen und FPS-Headerbindungen.

Hinweis:

Verwenden Sie diese Option, um den aktuellen Authentifizierungsblock des Connectors zu überprüfen. Um sie zu ändern, verwenden Sie auth set.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie „Konzepte“.

Beispiel

uip is connectors builder auth get

Datenform (--output json)

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

Geheime Konfigurationswerte (Kennwörter, API-Schlüssel) sind nie enthalten – nur die Metadaten der Konfiguration (Schlüssel, ob erforderlich/ausgeblendet, standardmäßig nicht geheimer Schlüssel).

UIP ist Connectors Builder-Authentifizierungssystem

Verwalten Sie Connector-Lebenszyklus-Ressourcen („System“) – Authentifizierungszeit-Hooks wie provisionAuthValidation, onProvision und oauthOnTokenRefresh. auth activity create activity create --skip-sr – siehe Aktivität und Hooks).

UIP ist Connectors Builder Authentifizierungssystem erstellen

Hinweis:

Verwenden Sie dies, um einen Lebenszyklus-Hook-Endpunkt zu verknüpfen – Authentifizierungsvalidierung, OnProvision oder einen Token-Refresh-Aufruf. Verwenden Sie dies nicht, um einen normalen API-Endpunkt hinzuzufügen – verwenden Sie builder activity create${DNT_1} stattdessen.

Optionen

Long	Wert	Beschreibung
--type <type>	string	Erforderlich. Systemressourcentyp, z. B. provisionAuthValidation, onProvision, oauthOnTokenRefresh.
--vendor-path <path>	Pfad	Anbieter-API-Pfad für diesen Hook.
--method <method>	HTTP-Methode	Die Standardeinstellung ist POST, wenn der Typ eine Methode erfordert.
--next-resource <selector>	METHOD:/path	Verketten Sie es mit einer nächsten Ressource, z. B. GET:/organization.
--path <path>	Pfad	Expliziter Ressourcenpfad – muss mit dem Überschreibungspfad des Typs übereinstimmen, wenn dieser Typ einen deklariert.
--connector-dir <path>	Pfad	Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie „Konzepte“.

Beispiel

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

Datenform (--output json)

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

UIP ist Connectors Builder-Authentifizierungssystemliste

Listet die Element.json-Einträge des Connectors auf, deren Typ eine Systemressource ist.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie „Konzepte“.

Beispiel

uip is connectors builder auth system list

Datenform (--output json)

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

Zugehörig

• Übersicht und Mandantenlebenszyklus – Konzepte, die für alle Builder-Seiten freigegeben werden, plus download/import/publish/publish-status.
• Init und Connector – Erstellen Sie ein Gerüst für einen Connector, bevor Sie seine Authentifizierung konfigurieren.
• Aktivität und Hooks – Definieren Sie die Endpunkte, die diese Authentifizierung verwenden, sobald sie konfiguriert ist.
• Trigger und Status – Ereignistrigger und Bearbeitungen von Elementdateien auf niedriger Ebene.
• uip is connections – die mandantenseitige Runtime-Instanz des hier konfigurierten Schemas.

Siehe auch

• Übersicht über das Integration Service-Tool
• Globale Optionen
• Exitcodes