aplicativos externos do administrador do uip

Sintaxe e opções para "uip admin External-apps", que gerencia registros de clientes do OAuth2 e suas credenciais federadas para integrações de aplicativos externos.

uip admin external-apps gerencia registros de clientes do OAuth2 — aplicativos externos e serviços que se autenticam no UiPath usando seu próprio ID/segredo do cliente (ou federação de identidade de carga de trabalho) em vez do próprio login de um usuário. Cada aplicativo é confidencial (no lado do servidor, tem um segredo) ou não confidencial (público, por exemplo, um SPA ou aplicativo móvel, sem segredo). Um grupo aninhado federated-credentials gerencia associações de identificação de carga de trabalho (por exemplo GitHub Actions OIDC) que permitem que um aplicativo externo seja autenticado sem um segredo estático.

Resumo

uip admin external-apps list
uip admin external-apps get <client-id>
uip admin external-apps create <name> [--redirect-uri <uri>] [--user-scope <scopes>] [--app-scope <scopes>] [--non-confidential] [--no-secret]
uip admin external-apps update <client-id> [--name <name>] [--redirect-uri <uri>] [--user-scope <scopes>] [--app-scope <scopes>]
uip admin external-apps delete <client-id>
uip admin external-apps generate-secret <client-id> [--description <text>] [--expiration <date>]
uip admin external-apps delete-secret <secret-id>

uip admin external-apps federated-credentials list <client-id>
uip admin external-apps federated-credentials get <client-id> <credential-id>
uip admin external-apps federated-credentials create <client-id> --name <name> --issuer <url> --audience <audience> --subject <subject>
uip admin external-apps federated-credentials update <client-id> <credential-id> --name <name> --issuer <url> --audience <audience> --subject <subject>
uip admin external-apps federated-credentials delete <client-id> <credential-id>

Verbo

Grupo	Texto	Finalidade
external-apps	list	Liste apps externos na partição.
external-apps	get	Obtenha os detalhes de um aplicativo por ID do cliente.
external-apps	create	Registre um novo cliente OAuth2.
external-apps	update	Atualizar o nome de um aplicativo, URI de redirecionamento ou escopos.
external-apps	delete	Excluir um aplicativo por ID do cliente.
external-apps	generate-secret	Gerar um novo segredo do cliente.
external-apps	delete-secret	Excluir um segredo do cliente específico.
federated-credentials	list	Lista as credenciais federadas de um app.
federated-credentials	get	Obter uma credencial federada por ID.
federated-credentials	create	Associe um provedor de identidade externo (por exemplo GitHub Actions OIDC) ao aplicativo.
federated-credentials	update	Atualize uma credencial federada.
federated-credentials	delete	Remova uma credencial federada.

Conceitos

• Confidencial versus não confidencial. O padrão é confidencial (o lado do servidor, obtém um segredo do cliente). --non-confidential cria um cliente público sem segredo — ele é compatível apenas com --user-scope escopos (delegados),--app-scope nunca; passar --app-scope em um aplicativo não confidencial falha no lado do cliente.
• Os escopos são divididos por tipo de concessão. --user-scope (delegado, requer um usuário conectado) e --app-scope (somente aplicativos, concessão de credenciais do cliente) são listas independentes — aprovam um ou ambos. É necessário pelo menos um em create. Consulte uip admin scopes list para obter o catálogo completo de nomes de escopos disponíveis.
• --scope é um alias obsoleto para --app-scope. Se ambos forem fornecidos, --app-scope prevalece; um valor em branco (uma string vazia ou com apenas espaço em branco) é rejeitado em vez de ser tratado silenciosamente como "sem escopos".
• Um URI de redirecionamento é necessário sempre que escopos de usuários estão envolvidos — seja porque o aplicativo não é confidencial ou porque --user-scope foi passado — pois ambos precisam do fluxo de código de autorização do OAuth2. Um aplicativo confidencial e somente com escopo de aplicativos não precisa de um.
• update deriva novamente escopos de recursos quando você não passa nenhum — se você omitir --user-scope e --app-scope, o comando reenvia os escopos existentes do aplicativo inalterados em vez de limpá-los; a mesma validação de URI não confidencial/redirecionamento que create ainda se aplica a qualquer que seja o escopo final definido e o URI de redirecionamento que acabe sendo.
• Os segredos são mostrados uma vez. O valor retornado de generate-secret não pode ser recuperado novamente — armazene-o imediatamente.

lista de aplicativos externos do administrador do uip

Liste apps externos na partição. Sem opções de filtragem/paginação.

Exemplo

uip admin external-apps list

Formato dos dados (--output json)

{ "Code": "ExternalClientList", "Data": [{ "id": "my-app", "name": "My Application", "isConfidential": true }] }

aplicativos externos do administrador do uip obter

Obtenha detalhes do aplicativo externo por ID do cliente.

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo. Encontre-o com external-apps list.

Exemplo

uip admin external-apps get my-app

Formato dos dados (--output json)

{ "Code": "ExternalClientDetails", "Data": { "id": "my-app", "name": "My Application", "isConfidential": true, "redirectUri": "https://example.com/callback" } }

criação de aplicativos externos do administrador do uip

Crie um aplicativo externo (confidencial por padrão).

Argumentos

Name	Required	Finalidade
<name>	sim	Nome de exibição do aplicativo.

Opções

Long	Valor	Description
--redirect-uri <uri>	separados por vírgula	URI(s) de redirecionamento para o fluxo OAuth2. Obrigatório quando não confidencial ou quando --user-scope está definido.
--user-scope <scopes>	separados por vírgula ou espaço	Escopos (usuário) delegado.
--app-scope <scopes>	separados por vírgula ou espaço	Escopos de aplicativos (somente aplicativos). Não permitido em um aplicativo não confidencial.
--scope <scopes>	separados por vírgula ou espaço	Alias obsoleto de --app-scope.
--non-confidential	Bandeira	Crie um cliente público (sem segredo).
--no-secret	Bandeira	Ignore a geração de um segredo do cliente na criação (apenas aplicativos confidenciais).

Pelo menos um dos --user-scope/--app-scope é necessário.

Exemplos

# Confidential app with application scopes only
uip admin external-apps create "My App" --app-scope "OR.Folders,OR.Assets"

# Confidential app with both user and app scopes
uip admin external-apps create "My App" --user-scope "OR.Folders" --app-scope "OR.Jobs" --redirect-uri "https://example.com/callback"

# Public client (SPA) with user scopes
uip admin external-apps create "My SPA" --non-confidential --user-scope "OR.Folders" --redirect-uri "http://localhost:3000/callback"

Formato dos dados (--output json)

{ "Code": "ExternalClientCreated", "Data": { "id": "my-app", "name": "My App", "isConfidential": true, "secret": "generated-secret-value" } }

secret está presente apenas para um aplicativo confidencial criado sem --no-secret.

atualização de aplicativos externos do administrador do uip

Atualizar o nome de um aplicativo, URI de redirecionamento ou escopos. Pelo menos --name/--redirect-uri/--user-scope/--app-scope é necessário.

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.

Opções

Long	Short	Valor	Description
--name <name>	-n	String	Novo nome de exibição.
--redirect-uri <uri>		separados por vírgula	Novo(s) URI(s) de redirecionamento.
--user-scope <scopes>		separados por vírgula ou espaço	Novos escopos delegados.
--app-scope <scopes>		separados por vírgula ou espaço	Novos escopos de aplicativos.
--scope <scopes>		separados por vírgula ou espaço	Alias obsoleto de --app-scope.

Exemplo

uip admin external-apps update my-app-id --name "Updated App" --app-scope "OR.Folders"

Formato dos dados (--output json)

{ "Code": "ExternalClientUpdated" }

exclusão de aplicativos externos do administrador do uip

Excluir um aplicativo externo por ID do cliente.

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.

Exemplo

uip admin external-apps delete my-app-id

Formato dos dados (--output json)

{ "Code": "ExternalClientDeleted", "Data": { "Id": "my-app-id", "Status": "Deleted successfully" } }

administrador uip apps externos gerar-segredo

Gere um novo segredo para um aplicativo externo. O valor do segredo é mostrado apenas uma vez.

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.

Opções

Long	Valor	Description
--description <text>	String	Descrição do segredo.
--expiration <date>	ISO 8601	Data de expiração.

Exemplo

uip admin external-apps generate-secret my-app

Formato dos dados (--output json)

{ "Code": "ExternalClientSecretGenerated", "Data": { "id": 1, "secret": "generated-secret-value" } }

segredo-exclusão do administrador dos aplicativos externos do uip

Excluir um segredo específico de um aplicativo externo — um aplicativo pode ter vários segredos ativos; isso remove apenas um.

Argumentos

Name	Required	Finalidade
<secret-id>	sim	ID do segredo (numérico). Encontre-o por meio de external-apps get.

Exemplo

uip admin external-apps delete-secret 12345

Formato dos dados (--output json)

{ "Code": "ExternalClientSecretDeleted", "Data": { "Id": "12345", "Status": "Deleted successfully" } }

administrador externo-apps federados-lista de credenciais do administrador do uip

Lista as credenciais federadas de um app externo.

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.

Exemplo

uip admin external-apps federated-credentials list my-app-id

Formato dos dados (--output json)

{ "Code": "FederatedCredentialList", "Data": [{ "id": "fc000000-0000-0000-0000-000000000001", "name": "GitHub Actions", "issuer": "https://token.actions.githubusercontent.com" }] }

uip admin externos-apps federados-credenciais obter

Obter uma credencial federada por ID.

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.
<credential-id>	sim	ID de credencial federada (UUID).

Exemplo

uip admin external-apps federated-credentials get my-app-id fc000000-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "FederatedCredentialDetails",
  "Data": {
    "id": "fc000000-0000-0000-0000-000000000001",
    "name": "GitHub Actions",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "api://AzureADTokenExchange",
    "subject": "repo:org/repo:ref:refs/heads/main"
  }
}

administrador externo-apps federados-credenciais do uip criar

Vincular um provedor de identidade externo ao aplicativo — permite a federação de identidade de carga de trabalho (por exemplo, um fluxo de trabalho do GitHub Actions autenticando sem um segredo armazenado).

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.

Opções

Long	Short	Valor	Required	Description
--name <name>	-n	String	sim	Nome da credencial.
--issuer <url>		url	sim	URL do emissor do token, por exemplo https://token.actions.githubusercontent.com).
--audience <audience>		String	sim	Declaração do público esperado, por exemplo api://AzureADTokenExchange).
--subject <subject>		String	sim	Declaração do assunto esperada, por exemplo repo:org/repo:ref:refs/heads/main).
--description <text>		String	não	Descrição.

Exemplo

uip admin external-apps federated-credentials create my-app-id \
  --name "GitHub Actions" \
  --issuer "https://token.actions.githubusercontent.com" \
  --audience "api://AzureADTokenExchange" \
  --subject "repo:org/repo:ref:refs/heads/main"

Formato dos dados (--output json)

{ "Code": "FederatedCredentialCreated" }

atualização de credenciais federadas do administrador externo-apps do administrador do uip

Atualizar uma credencial federada — todos os quatro campos de identidade são necessários em cada chamada (sem atualização parcial).

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.
<credential-id>	sim	ID de credencial federada (UUID).

Opções

Long	Short	Valor	Required	Description
--name <name>	-n	String	sim	Nome da credencial.
--issuer <url>		url	sim	URL do emissor do token.
--audience <audience>		String	sim	Declaração de público esperado.
--subject <subject>		String	sim	Declaração de assunto esperada.
--description <text>		String	não	Descrição.

Exemplo

uip admin external-apps federated-credentials update my-app-id fc000000-0000-0000-0000-000000000001 \
  --name "GitHub Actions (prod)" \
  --issuer "https://token.actions.githubusercontent.com" \
  --audience "api://AzureADTokenExchange" \
  --subject "repo:org/repo:environment:production"

Formato dos dados (--output json)

{ "Code": "FederatedCredentialUpdated" }

exclusão de credenciais-excluir do administrador externo-apps federados

Exclua uma credencial federada de um aplicativo externo.

Argumentos

Name	Required	Finalidade
<client-id>	sim	ID do aplicativo externo.
<credential-id>	sim	ID de credencial federada (UUID).

Exemplo

uip admin external-apps federated-credentials delete my-app-id fc000000-0000-0000-0000-000000000001

Formato dos dados (--output json)

{ "Code": "FederatedCredentialDeleted", "Data": { "Id": "fc000000-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }

Relacionado

• uip admin robot-accounts / pat / scopes — o catálogo de escopos OAuth2 compartilhado do qual esses aplicativos são extraídos.
• uip admin users — usuários e grupos do diretório.
• uip admin smtp — configuração de e-mail da organização.

Veja também

• Opções globais
• Códigos de saída