Aplicaciones externas de administrador de UIP

Sintaxis y opciones para `uip admin external-apps`, que gestiona los registros de clientes OAuth2 y sus credenciales federadas para integraciones de aplicaciones externas.

uip admin external-apps gestiona los registros de clientes OAuth2: aplicaciones y servicios externos que se autentican en UiPath utilizando su propio ID/secreto de cliente (o identidad federada de carga de trabajo) en lugar de un inicio de sesión propio de usuario. Cada aplicación es confidencial (del lado del servidor, tiene un secreto) o no confidencial (pública, por ejemplo, una aplicación SPA o móvil, sin secreto). Un grupo federated-credentials anidado gestiona los enlaces de carga de trabajo-identidad-federación (por ejemplo GitHub Actions OIDC) que permite a una aplicación externa autenticarse sin ningún secreto estático.

Sinopsis

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>

Verbos

Grupo	Verbo	Propósito
external-apps	list	Enumera las aplicaciones externas en la partición.
external-apps	get	Obtener los detalles de una aplicación por ID de cliente.
external-apps	create	Registra un nuevo cliente OAuth2.
external-apps	update	Actualizar el nombre de una aplicación, el URI de redirección o los ámbitos.
external-apps	delete	Eliminar una aplicación por ID de cliente.
external-apps	generate-secret	Genera un nuevo secreto de cliente.
external-apps	delete-secret	Eliminar un secreto de cliente específico.
federated-credentials	list	Enumerar las credenciales federadas de una aplicación.
federated-credentials	get	Obtenga una credencial federada por ID.
federated-credentials	create	Vincula un proveedor de identidad externo (por ejemplo GitHub Actions OIDC) a la aplicación.
federated-credentials	update	Actualizar una credencial federada.
federated-credentials	delete	Eliminar una credencial federada.

Conceptos

• Confidencial frente a no confidencial. El valor predeterminado es confidencial (del lado del servidor, obtiene un secreto de cliente). --non-confidential crea un cliente público sin secreto: solo admite --user-scope ámbitos (delegados), nunca --app-scope; pasar --app-scope en una aplicación no confidencial falla en el lado del cliente.
• Los ámbitos se dividen por tipo de concesión. --user-scope (delegado, requiere un usuario que haya iniciado sesión) y --app-scope (solo aplicación, concesión de credenciales de cliente) son listas independientes: pasa una o ambas. Se requiere al menos uno en create. Consulta uip admin scopes list para obtener el catálogo completo de nombres de ámbito disponibles.
• --scope es un alias obsoleto para --app-scope. Si se dan ambos, --app-scope gana; un valor en blanco en cualquiera de los dos (una cadena vacía o solo espacios en blanco) se rechaza en lugar de tratarse silenciosamente como "sin ámbitos";
• Se requiere un URI de redirección siempre que se trate de ámbitos de usuario , ya sea porque la aplicación no es confidencial o porque se pasó --user-scope , ya que ambos necesitan el flujo de código de autorización OAuth2. Una aplicación que es confidencial y solo de ámbito de aplicación no la necesita.
• update vuelve a derivar los ámbitos de los recursos cuando no pasas ninguno : si omites tanto --user-scope como --app-scope, el comando reenvía los ámbitos existentes de la aplicación sin cambios en lugar de borrarlos; la misma validación no confidencial/URI de redirección que create sigue aplicándose a cualquiera que sea el conjunto de ámbito final y el URI de redirección.
• Los secretos se muestran una vez. El valor devuelto de generate-secret no se puede volver a recuperar: guárdelo inmediatamente.

lista de aplicaciones externas del administrador de UIP

Enumera las aplicaciones externas en la partición. Sin opciones de filtrado/paginación.

Ejemplo

uip admin external-apps list

Forma de datos (--json de salida)

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

uip admin external-apps get

Obtener detalles de la aplicación externa por ID de cliente.

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa. Encuéntralo con external-apps list.

Ejemplo

uip admin external-apps get my-app

Forma de datos (--json de salida)

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

crear aplicaciones externas de administrador de UIP

Crea una aplicación externa (confidencial de forma predeterminada).

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre para mostrar de la aplicación.

Opciones

Largo	Valor	Descripción
--redirect-uri <uri>	separados por comas	URI de redireccionamiento para el flujo OAuth2. Obligatorio cuando no confidencial o cuando se establece --user-scope.
--user-scope <scopes>	separados por comas o espacios	Ámbitos delegados (usuario).
--app-scope <scopes>	separados por comas o espacios	Ámbitos de la aplicación (solo aplicación). No permitido en una aplicación no confidencial.
--scope <scopes>	separados por comas o espacios	Alias obsoleto para --app-scope.
--non-confidential	Marca	Crea un cliente público (sin secreto).
--no-secret	Marca	Omitir la generación de un secreto de cliente en la creación (solo aplicaciones confidenciales).

Se requiere al menos uno de --user-scope/--app-scope.

Ejemplos

# 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"

Forma de datos (--json de salida)

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

secret está presente solo para una aplicación confidencial creada sin --no-secret.

Actualización de aplicaciones externas de administrador de UIP

Actualizar el nombre de una aplicación, el URI de redirección o los ámbitos. Se requiere al menos uno de --name/--redirect-uri/--user-scope/--app-scope.

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.

Opciones

Largo	Corto	Valor	Descripción
--name <name>	-n	String	Nuevo nombre para mostrar.
--redirect-uri <uri>		separados por comas	Nuevos URI de redireccionamiento.
--user-scope <scopes>		separados por comas o espacios	Nuevos ámbitos delegados.
--app-scope <scopes>		separados por comas o espacios	Nuevos ámbitos de aplicación.
--scope <scopes>		separados por comas o espacios	Alias obsoleto para --app-scope.

Ejemplo

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

Forma de datos (--json de salida)

{ "Code": "ExternalClientUpdated" }

Eliminar aplicaciones externas de administrador de UIP

Eliminar una aplicación externa por ID de cliente.

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.

Ejemplo

uip admin external-apps delete my-app-id

Forma de datos (--json de salida)

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

uip admin external-apps generate-secret

Genere un nuevo secreto para una aplicación externa. El valor secreto se muestra solo una vez.

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.

Opciones

Largo	Valor	Descripción
--description <text>	String	Descripción del secreto.
--expiration <date>	ISO 8601	Fecha de vencimiento.

Ejemplo

uip admin external-apps generate-secret my-app

Forma de datos (--json de salida)

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

uip admin aplicaciones externas eliminar-secreto

Eliminar un secreto específico de una aplicación externa: una aplicación puede tener varios secretos activos; esto elimina solo uno.

Argumentos

Nombre	Obligatorio	Propósito
<secret-id>	Sí	ID secreto (numérico). Encuéntralo a través de external-apps get.

Ejemplo

uip admin external-apps delete-secret 12345

Forma de datos (--json de salida)

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

lista de credenciales federadas de aplicaciones externas de administrador de UIP

Enumerar las credenciales federadas para una aplicación externa.

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.

Ejemplo

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

Forma de datos (--json de salida)

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

uip admin external-apps federated-credentials get

Obtenga una credencial federada por ID.

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.
<credential-id>	Sí	ID de credencial federada (UUID).

Ejemplo

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

Forma de datos (--json de salida)

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

Crear credenciales federadas de aplicaciones externas de administrador de UIP

Vincula un proveedor de identidad externo a la aplicación: habilita la federación de identidad de la carga de trabajo (por ejemplo, un flujo de trabajo de GitHub Actions que se autentica sin un secreto almacenado).

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.

Opciones

Largo	Corto	Valor	Obligatorio	Descripción
--name <name>	-n	String	Sí	Nombre de la credencial.
--issuer <url>		url	Sí	URL del emisor del token, por ejemplo https://token.actions.githubusercontent.com.
--audience <audience>		String	Sí	Reclamación de audiencia esperada, por ejemplo api://AzureADTokenExchange.
--subject <subject>		String	Sí	Reclamación de asunto esperada, por ejemplo repo:org/repo:ref:refs/heads/main.
--description <text>		String	No	Descripción.

Ejemplo

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"

Forma de datos (--json de salida)

{ "Code": "FederatedCredentialCreated" }

Actualización de credenciales federadas de aplicaciones externas de administrador de UIP

Actualizar una credencial federada: los cuatro campos de identidad son obligatorios en cada llamada (sin actualización parcial).

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.
<credential-id>	Sí	ID de credencial federada (UUID).

Opciones

Largo	Corto	Valor	Obligatorio	Descripción
--name <name>	-n	String	Sí	Nombre de la credencial.
--issuer <url>		url	Sí	URL del emisor del token.
--audience <audience>		String	Sí	Reclamación de audiencia esperada.
--subject <subject>		String	Sí	Reclamación de asunto esperada.
--description <text>		String	No	Descripción.

Ejemplo

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"

Forma de datos (--json de salida)

{ "Code": "FederatedCredentialUpdated" }

Eliminar credenciales federadas de aplicaciones externas de administrador de UIP

Eliminar una credencial federada de una aplicación externa.

Argumentos

Nombre	Obligatorio	Propósito
<client-id>	Sí	ID de aplicación externa.
<credential-id>	Sí	ID de credencial federada (UUID).

Ejemplo

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

Forma de datos (--json de salida)

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

Relacionado

• uip admin robot-accounts / pat / scopes : el catálogo de ámbito OAuth2 compartido del que se basan estas aplicaciones.
• uip admin users : usuarios y grupos del directorio.
• uip admin smtp — configuración del correo electrónico de la organización.

Ver también

• Opciones globales
• Códigos de salida