uip est l'authentification du générateur de connecteurs

Syntaxe et options pour configurer et inspecter le schéma d'authentification d'un connecteur avec le générateur de connecteurs Integration Service — ensemble d'authentification, obtention d'authentification et création/liste de système d'authentification.

Cette page couvre uip is connectors builder auth, le groupe de commandes qui définit le propre schéma d'authentification d'un connecteur - comment le connecteur lui-même communique avec son API de fournisseur. Il s’agit d’une préoccupation au moment de la conception, distincte d’une connexion à un locataire, qui est une instance de runtime de ce schéma (les informations d’identification d’un utilisateur spécifique par rapport au schéma configuré sur cette page). Pour la résolution du répertoire du connecteur, la distinction entre la conception et la publication et le flux de création global, voir Concepts sur la page parente.

Synthèse

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

Aucune de ces options n'est à l'échelle du locataire - il n'y a aucun indicateur --tenant nulle part dans ce groupe. Tout ce qui se trouve ici modifie ou lit uniquement le répertoire du connecteur local.

uip est un ensemble d’authentification du générateur de connecteurs

Configurez l’authentification au niveau du connecteur. Un --auth-type est requis; laquelle des options restantes s'applique dépend de ce type. La réexécution avec un connecteur déjà configuré échoue à moins que --force ne soit transmis, ce qui applique la différence aux entrées de configuration existantes au lieu de l'erreur. Cela existe car une première tentative peut être rejetée (par exemple, une modification des options d'étendue qui entre en conflit avec configuration existante) et doit être réessayé.

Remarque :

Utilisez cette option pour connecter l'authentification à un connecteur existant, pour l'un des types d'authentification ci-dessous, ou pour échanger le type d'authentification d'un connecteur existant (--force). Définissez également les étendues OAuth/JWT ici, via --scope-options/--required-scopes/--preselected-scopes — il n'y a pas de commande auth scope distincte. Ne l'utilisez pas pour créer un connecteur à partir de zéro — utilisez d'abord builder init . Ne l'utilisez pas pour les entrées de configuration non authentifiées - utilisez builder init preset apply ou builder state patch (voir Déclencheur et état).

Options

Long	Valeur (Value)	ApplicableÀ	Description
--auth-type <type>	l'un des types ci-dessous	Tout	Requis. Le flux d’authentification à configurer.
--connector-dir <path>	Chemin d'accès	Tout	Répertoire des connecteurs. Même ordre de résolution que Concepts.
--force	Drapeau	Tout	Appliquez des différences aux entrées de configuration existantes au lieu de générer des erreurs lorsque le connecteur est déjà configuré.
--authorization-url <url>	url	OAuth	URL de connexion/de consentement.
--token-url <url>	url	OAuth, JWT	Point de terminaison de jeton.
--token-refresh-url <url>	url	OAuth	La valeur par défaut est --token-url.
--token-revoke-url <url>	url	OAuth	Point de terminaison de révocation du jeton.
--scope <scope>	string	OAuth, JWT, firstPartyService	Chaîne d’étendue délimitée par des espaces. Pour firstPartyService, l'étendue de la plate-forme que porte le jeton extrait.
--jwt-claim <spec>	name[=value][;label=...][;hint=...], répétable	jwtOauth, jwtOauth2	Revendication d'assertion JWT. Un nom brut (pas de =value) est créé, obligatoire et vide, afin que l'utilisateur de la connexion le renseigne au moment de la connexion; label/hint définissent le nom complet du formulaire de connexion et le texte de l'indice.
--jwt-header <spec>	même syntaxe que --jwt-claim, répétable	jwtOauth, jwtOauth2	En-tête d'assertion JWT.
--aws-service-name <name>	string	awsv4	Constante du nom du service SigV4 (par exemple polly, connect); définit la valeur aws.service.name masquée par défaut.
--scope-options <json>	Tableau JSON de {description, value}	OAuth, JWT	Choix d’étendues à sélection multiple proposés à l’utilisateur de connexion.
--scope-options-file <path>	Chemin d'accès	OAuth, JWT	Lire --scope-options JSON à partir d'un fichier plutôt qu'en ligne.
--required-scopes <csv>	Séparé par des virgules	OAuth, JWT	Des étendues que l’utilisateur ne peut pas désélectionner.
--preselected-scopes <csv>	Séparé par des virgules	OAuth, JWT	Étendues pré-vérifiées par défaut.
--scope-delimiter <char>	string	OAuth, JWT	Séparateur d'étendue. Par défaut: espace.
--scope-hint-text <text>	string	OAuth, JWT	Texte de l'indice affiché sous le sélecteur d'étendue.
--scope-screen-type <type>	string	OAuth, JWT	configScreenType pour l'entrée d'étendue. Par défaut: pre.
--api-key-param-name <name>	string	customApiKey	En-tête du fournisseur ou nom du paramètre de requête requis.
--api-key-location <where>	header | query	customApiKey	L'endroit où la clé est envoyée. Par défaut: header.
--api-key-prefix <prefix>	string	customApiKey	Préfixe littéral précédé de la valeur de la clé.
--key-config-name <key>	string	customApiKey	Clé de configuration interne. Par défaut: custom.api.key.
--key-config-display-name <name>	string	customApiKey	Libellé de l'interface utilisateur. Par défaut: API Key.
--validation-vendor-path <path>	Chemin d'accès	tout (facultatif)	Ajoutez un provisionAuthValidation appel de test à ce chemin de fournisseur.
--validation-method <method>	Méthode HTTP	tout (facultatif)	Méthode d'appel de validation d'authentification. Par défaut et recommandé: GET — la sonde doit être en lecture seule et ne doit pas modifier les données du fournisseur.
--auth-header <kv>	ConfigName=VendorHeader, répétable	schémas à en-têtes multiples	En-tête d'authentification statique supplémentaire, créé sous forme de configuration de texte brut que l'utilisateur de connexion remplit. Pour les schémas nécessitant plus d'un en-tête d'informations d'identification (par exemple API-AppId/API-Username d'iContact).
--secret-auth-header <kv>	ConfigName=VendorHeader, répétable	schémas à en-têtes multiples	Identique à --auth-header, mais la configuration est créée en tant que champ de mot de passe chiffré. Pour les en-têtes d'identification tels que API-Password.

--auth-type accepte l'un des éléments suivants: oauth2, oauth2Pkce, oauth2ClientCredentials, oauth2Password, oauth2PrivateKeyJwt, oauth1, basic, jwtOauth, jwtOauth2, custom, customApiKey, personalAccessToken, awsv4, googleServiceAccount, rsaCertificate, none, firstPartyService, fpsUserDelegatedAccess, fpsRobotAccess.

firstPartyService est une identité injectée par la plateforme UiPath: la plateforme analyse et actualise le jeton, liant {host}/{account}/{tenant} aux en-têtes de la plate-forme au lieu des champs de configuration au moment de la connexion (ces trois champs sont en fait supprimés de la configuration défini lorsque vous passez à ce type, comme illustré dans l'exemple ci-dessous).

Chaque type d'authentification écrit un ensemble de configuration différent - les exemples ci-dessous affichent chacun un résultat réel spécifique au type plutôt qu'une forme générique.

Exemples

# 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 est l'obtention d'authentification du générateur de connecteurs

Lisez la configuration complète de l’authentification du connecteur: type, entrées de configuration (clés secrètes caviardées), ressources du cycle de vie et liaisons d’en-tête FPS.

Remarque :

Utilisez cette option pour inspecter le bloc d'authentification actuel du connecteur. Pour le modifier, utilisez auth set.

Options

Long	Valeur (Value)	Description
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs. Même ordre de résolution que Concepts.

Exemple

uip is connectors builder auth get

Format des données (--sortie 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
  }
}

Les valeurs de configuration de type Clé secrète (mots de passe, clés API) ne sont jamais incluses, — uniquement les métadonnées de la configuration (clé, si elle est requise/masquée, valeur par défaut non secrète).

uip est le système d’authentification du générateur de connecteurs

Gérer les ressources de cycle de vie du connecteur (« système ») — les hooks authentification tels que provisionAuthValidation, onProvision et oauthOnTokenRefresh. Ceux-ci se trouvent sous auth car il s'agit de hooks authentification-cycle de vie: entrées élément.json sans fichier SR (ressource sémantique) distinct, contrairement à un point de terminaison d'API normal créé par activity create (ou un point de terminaison ad-hoc sans SR via activity create --skip-sr — voir Activité et hooks).

uip est la création d'un système d'authentification du générateur de connecteurs

Remarque :

Utilisez cette option pour connecter un point de terminaison de hook du cycle de vie — auth-validation, onProvision ou un jeton d'actualisation. Ne l'utilisez pas pour ajouter un point de terminaison d'API normal — utilisez builder activity create à la place.

Options

Long	Valeur (Value)	Description
--type <type>	string	Requis. Type de ressource système, par exemple provisionAuthValidation, onProvision, oauthOnTokenRefresh.
--vendor-path <path>	Chemin d'accès	Chemin d’accès à l’API fournisseur pour ce hook.
--method <method>	Méthode HTTP	La valeur par défaut est POST lorsque le type nécessite une méthode.
--next-resource <selector>	METHOD:/path	Chaînez vers une ressource suivante, par exemple GET:/organization.
--path <path>	Chemin d'accès	Chemin de ressource explicite — doit correspondre au chemin de remplacement du type lorsque ce type en déclare un.
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs. Même ordre de résolution que Concepts.

Exemple

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

Format des données (--sortie json)

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

uip est une liste de systèmes d'authentification du générateur de connecteurs

Répertorie les entrées element.json du connecteur dont le type est une ressource système.

Options

Long	Valeur (Value)	Description
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs. Même ordre de résolution que Concepts.

Exemple

uip is connectors builder auth system list

Format des données (--sortie json)

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

Associé

• Vue d'ensemble et cycle de vie du locataire - concepts partagés entre toutes les pages du générateur, plus download/import/publish/publish-status.
• Initialiser et connecteur — élaboration d'un connecteur avant de configurer son authentification.
• Activité et hooks — définissez les points de terminaison qui utilisent cette authentification une fois qu'il est configuré.
• Déclencheur et état — déclencheurs d'événements et modifications de fichiers d'éléments de bas niveau.
• uip is connections — l'instance de runtime côté locataire du schéma configuré ici.

Voir également

• Présentation de l’outil Integration Service
• Options globales
• Codes de sortie