uip é autenticação do construtor de conectores

Sintaxe e opções para configurar e inspecionar o esquema de autenticação de um conector com o construtor de conector do Integration Service — auth set, auth get e auth system Create/list.

Esta página abrange uip is connectors builder auth, o grupo de comando que define o próprio esquema de autenticação de um conector — como o próprio conector se comunica com sua API do fornecedor. Essa é uma questão de tempo de design, distinta de uma conexão de tenant, que é uma instância de runtime desse esquema (as credenciais de um usuário específico em relação ao esquema que esta página configura). Para obter a resolução do diretório do conector, a distinção design versus publicação e o fluxo de criação geral, consulte Conceitos na página principal.

Resumo

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

Nenhuma dessas opções tem o escopo de tenant — não há sinalizador --tenant em nenhum lugar neste grupo. Tudo aqui edita ou lê apenas o diretório do conector local.

uip é conjunto de autenticação do construtor de conectores

Configure a autenticação no conector. Um --auth-type é necessário; qual das opções restantes se aplicam depende desse tipo. A nova execução em um conector já configurado falha a menos que --force seja passado, o que aplica a comparação das entradas de configuração existentes em vez de erros — isso existe porque uma primeira tentativa pode ser rejeitada (por exemplo, uma alteração nas opções do escopo que entra em conflito com configuração existente) e precisa ser repetido.

Observação:

Use isso para conectar a autenticação em um conector existente, para qualquer um dos tipos de autenticação abaixo ou para trocar o tipo de autenticação de um conector existente (--force). Defina escopos OAuth/JWT aqui também, por meio de --scope-options/--required-scopes/--preselected-scopes — não há um comando auth scope separado. Não use isso para criar um conector do zero — use builder init primeiro. Não use isso para entradas de configuração não autenticadas — use builder init preset apply ou builder state patch (consulte Gatilho e estado).

Opções

Long	Valor	AplicávelA	Description
--auth-type <type>	um dos tipos abaixo	tudo	Obrigatório. O fluxo de autenticação a ser configurado.
--connector-dir <path>	Path	tudo	Diretório do conector. Mesma ordem de resolução que Conceitos.
--force	Bandeira	tudo	Aplique diferenças a entradas de configuração existentes em vez de gerar erros quando o conector já está configurado.
--authorization-url <url>	url	OAuth	URL de login/consentimento.
--token-url <url>	url	OAuth, JWT	Ponto de extremidade do token.
--token-refresh-url <url>	url	OAuth	O padrão é --token-url.
--token-revoke-url <url>	url	OAuth	Ponto de extremidade de revogação do token.
--scope <scope>	String	OAuth, JWT, firstPartyService	String de escopo delimitada por espaço. Para firstPartyService, o escopo da plataforma que o token criado carrega.
--jwt-claim <spec>	name[=value][;label=...][;hint=...], repetível	jwtOauth, jwtOauth2	Declaração de asserção do JWT. Um nome simples (sem =value) é criado obrigatório e vazio para que o usuário da conexão o preencha no momento da conexão; label/hint define o nome de exibição do formulário de conexão e o texto da dica.
--jwt-header <spec>	mesma sintaxe que --jwt-claim, repetível	jwtOauth, jwtOauth2	Cabeçalho de asserção JWT.
--aws-service-name <name>	String	awsv4	Constante de nome do serviço SigV4 (por exemplo, polly, connect); define o padrão oculto aws.service.name.
--scope-options <json>	Matriz JSON de {description, value}	OAuth, JWT	Escolhas de escopo de seleção múltipla oferecidas ao usuário da conexão.
--scope-options-file <path>	Path	OAuth, JWT	Leia --scope-options JSON de um arquivo em vez de em linha.
--required-scopes <csv>	separados por vírgula	OAuth, JWT	Escopos que o usuário não pode desmarcar.
--preselected-scopes <csv>	separados por vírgula	OAuth, JWT	Escopos pré-verificados por padrão.
--scope-delimiter <char>	String	OAuth, JWT	Separador de escopo. Padrão: espaço.
--scope-hint-text <text>	String	OAuth, JWT	Texto de dica mostrado abaixo do seletor de escopo.
--scope-screen-type <type>	String	OAuth, JWT	configScreenType para a entrada de escopo. prePadrão:.
--api-key-param-name <name>	String	customApiKey	Cabeçalho do fornecedor obrigatório ou nome do parâmetro de consulta.
--api-key-location <where>	header | query	customApiKey	Para onde a chave é enviada. headerPadrão:.
--api-key-prefix <prefix>	String	customApiKey	Prefixo literal anexado ao valor da chave.
--key-config-name <key>	String	customApiKey	Chave de configuração interna. custom.api.keyPadrão:.
--key-config-display-name <name>	String	customApiKey	Rótulo da interface gráfica. API KeyPadrão:.
--validation-vendor-path <path>	Path	tudo (opcional)	Adicione uma chamada de teste provisionAuthValidation neste caminho do fornecedor.
--validation-method <method>	Método HTTP	tudo (opcional)	Método para a chamada de validação de autenticação. Padrão e recomendado: GET — o teste deve ser somente leitura e não deve alterar os dados do fornecedor.
--auth-header <kv>	ConfigName=VendorHeader, repetível	esquemas de vários cabeçalhos	Cabeçalho de autenticação estático extra, criado como uma configuração de texto simples que o usuário da conexão preenche. Para esquemas que precisam de mais de um cabeçalho de credencial (por exemplo, API-AppId/API-Username do iContact).
--secret-auth-header <kv>	ConfigName=VendorHeader, repetível	esquemas de vários cabeçalhos	Como --auth-header, mas a configuração é criada como um campo de senha criptografada. Para cabeçalhos de credenciais, como API-Password.

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

firstPartyService é a identidade injetada pela UiPath platform: a plataforma cria e atualiza o token, associando {host}/{account}/{tenant} aos cabeçalhos da plataforma em vez de campos de configuração em tempo de conexão (esses três campos são, na verdade, removidos da configuração definido quando você alterna para esse tipo, conforme mostrado no exemplo abaixo).

Cada tipo de autenticação grava um pacote de configuração diferente — os exemplos abaixo de cada um mostram um resultado real e específico do tipo em vez de uma forma genérica.

Exemplos

# 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 é a autenticação do construtor de conectores para obter

Leia a configuração de autenticação completa do conector: tipo, entradas de configuração (segredos editados), recursos do ciclo de vida e associações de cabeçalho FPS.

Observação:

Use isso para inspecionar o bloco de autenticação atual do conector. Para alterá-lo, use auth set.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector. Mesma ordem de resolução que Conceitos.

Exemplo

uip is connectors builder auth get

Formato dos dados (--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
  }
}

Os valores de configuração tipos secretos (senhas, chaves de API) nunca são incluídos — apenas os metadados da configuração (chave, se ela é necessária/oculta, padrão não secreto).

o uip é sistema de autenticação do construtor de conectores

Gerenciar recursos do ciclo de vida do conector ("sistema") — ganchos de tempo de autenticação, como provisionAuthValidation, onProvision e oauthOnTokenRefresh. activity create estão sob auth porque são activity create --skip-sr — consulte Atividade e ganchos).

uip é conector builder auth system criar

Observação:

Use isso para conectar um endpoint do hook do ciclo de vida — auth-validation, onProvision ou uma chamada de token-refresh. Não use isso para adicionar um ponto de extremidade de API normal — use builder activity create em vez disso.

Opções

Long	Valor	Description
--type <type>	String	Obrigatório. Tipo de recurso do sistema, por exemplo, provisionAuthValidation, onProvision, oauthOnTokenRefresh.
--vendor-path <path>	Path	Caminho da API do fornecedor para este hook.
--method <method>	Método HTTP	O padrão é POST quando o tipo exige um método.
--next-resource <selector>	METHOD:/path	Cadeia para um próximo recurso, por exemplo,.GET:/organization
--path <path>	Path	Caminho de recurso explícito — deve corresponder ao caminho de substituição do tipo quando esse tipo declara um.
--connector-dir <path>	Path	Diretório do conector. Mesma ordem de resolução que Conceitos.

Exemplo

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

Formato dos dados (--output json)

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

uip é lista de sistemas de auth do construtor de conectores

Lista as entradas elemento.json do conector cujo tipo é um recurso do sistema.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector. Mesma ordem de resolução que Conceitos.

Exemplo

uip is connectors builder auth system list

Formato dos dados (--output json)

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

Relacionado

• Visão geral e ciclo de vida do tenant — conceitos compartilhados em todas as páginas do construtor, além de download/import/publish/publish-status.
• Init e conector — estrutura um conector antes de configurar sua autenticação.
• Atividade e ganchos — defina os endpoints que usam essa autenticação depois de configurada.
• Gatilho e estado — gatilhos de eventos e edições de arquivo de elementos de baixo nível.
• uip is connections — a instância de runtime do lado do tenant do esquema configurado aqui.

Veja também

• Visão geral da ferramenta do Integration Service
• Opções globais
• Códigos de saída