lista de agentes da uip / compartilhar

uip agent list e uip agent share operam em soluções do Studio Web — a representação no lado da nuvem de um projeto de agente. list enumera soluções visíveis para o usuário atual; share gerencia o acesso de usuários e grupos a uma única solução. Elas são agrupadas aqui porque ambos são verbos puros de gerenciamento do Studio Web, distintos das operações no nível do arquivo em uip agent file e das operações no lado do Orchestrator em deploy / run.

Ambos os verbos exigem uma sessão de CLI ativa (uip login).

Todos os subcomandos respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

---

lista de agentes uip

Lista soluções do Studio Web, filtradas opcionalmente por uma palavra-chave.

Resumo

uip agent list [-s <query>] [-l <n>] [--login-validity <minutes>]

Argumentos

Nenhum.

Opções

Bandeira	Padrão	Finalidade
-s, --search <query>	—	Filtro de palavra-chave aplicado ao ponto de extremidade SearchSolutionsAndProjects do Studio Web.
-l, --limit <n>	20	Número máximo de resultados. Enviado como o parâmetro de consulta pagingOptions.limit .
--login-validity <minutes>	10	Mínimo de minutos de validade do token necessários.

Exemplos

# Simplest — list up to 20 solutions
uip agent list

# Filter by keyword
uip agent list --search invoice

# Page through larger result sets
uip agent list --limit 100

Formato dos dados (--output json)

{
  "Code": "AgentList",
  "Data": [
    {
      "Name": "Email Triage",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Status": "Completed",
      "PublishStatus": "Published",
      "LastModified": "2025-04-10T14:30:00Z",
      "Projects": 2
    }
  ]
}

Os conjuntos de resultados vazios produzem Data: { "Message": "No solutions found" } em vez de uma matriz vazia. Projects é a contagem de projetos aninhados dentro da solução, não uma listagem.

---

compartilhamento do agente de uip

Gerencie o acesso de usuários e grupos a uma solução do Studio Web. Três subcomandos: add, list e remove.

Resumo

uip agent share add    <solutionId> <entityId> [--permission <perm>] [--group] [--login-validity <minutes>]
uip agent share list   <solutionId>                                   [--login-validity <minutes>]
uip agent share remove <solutionId> <entityId>                        [--group] [--login-validity <minutes>]

adição de compartilhamento do agente uip

Conceda acesso a um usuário ou grupo.

Argumentos

• <solutionId> (necessário) — UUID da solução.
• <entityId> (necessário) — UUID do usuário ou do grupo.

Opções

Bandeira	Padrão	Finalidade
--permission <perm>	write	Nível de permissão. Um destes: none, read, write, publish, readWritePublish. Sem diferenciação entre maiúsculas e minúsculas; valores inválidos falham com um erro de validação.
--group	off (usuário)	Trate <entityId> como um grupo em vez de um usuário.
--login-validity <minutes>	10	Mínimo de minutos de validade do token necessários.

Exemplos

# Grant write access to a user
uip agent share add \
  a1b2c3d4-0000-0000-0000-000000000001 \
  a1b2c3d4-0000-0000-0000-000000000501 \
  --permission write

# Grant read-only access to a group
uip agent share add <solutionId> <groupId> --permission read --group

# Full access (read + write + publish)
uip agent share add <solutionId> <userId> --permission readWritePublish

Data shape (--output json)

{
  "Code": "AgentShare",
  "Data": {
    "Status": "Solution shared successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "SharedWith": "a1b2c3d4-0000-0000-0000-000000000501",
    "IsGroup": false,
    "Permission": "write"
  }
}

lista de compartilhamento de agentes uip

Liste usuários e grupos com acesso a uma solução.

Argumentos

• <solutionId> (necessário) — UUID da solução.

Opções

Only --login-validity.

Exemplo

uip agent share list a1b2c3d4-0000-0000-0000-000000000001

Data shape (--output json)

{
  "Code": "AgentShareList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000501",
      "Name": "Jane Doe",
      "Email": "[e-mail]",
      "IsGroup": false,
      "Permission": "write"
    }
  ]
}

Uma resposta vazia retorna Data: { "Message": "No sharing permissions found for this solution" }.

remoção de compartilhamento do agente uip

Revogar o acesso de um usuário ou grupo.

Argumentos

• <solutionId> (necessário) — UUID da solução.
• <entityId> (necessário) — UUID do usuário ou do grupo.

Opções

Bandeira	Padrão	Finalidade
--group	off (usuário)	Trate <entityId> como um grupo em vez de um usuário.
--login-validity <minutes>	10	Mínimo de minutos de validade do token necessários.

Exemplo

uip agent share remove a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000501

Data shape (--output json)

{
  "Code": "AgentShareRemove",
  "Data": {
    "Status": "Access removed successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "RemovedEntity": "a1b2c3d4-0000-0000-0000-000000000501"
  }
}

---

Relacionado

• uip agent push — importe um projeto e obtenha o SolutionId que você usa aqui.
• uip agent pull — baixe uma solução listada por list.
• uip agent file — listar, baixar e carregar arquivos dentro dos projetos de uma solução.

Veja também

• Autenticação — sessões, tenants e --login-validity.
• Opções globais, Códigos de saída.