UIP ou funções

Sintaxe e opções para "uip ou funções", que gerencia funções, permissões e atribuições no nível da pasta do RBAC do Orchestrator.

uip or roles gerencia funções e permissões do Orchestrator (RBAC). As funções agrupam permissões e são atribuídas a usuários, grupos, robôs, máquinas ou aplicativos externos no nível do tenant (globalmente) ou da pasta (com escopo). Os verbos nesta página cobrem as funções e suas permissões, associação ao usuário da função, inspeção de funções/permissões no nível principal e atribuições no nível da pasta. Para atribuição de função no nível do tenant por usuário, consulte users assign-roles em uip or users.

Resumo

uip or roles permissions list [options]
uip or roles list [options]
uip or roles get <role-key>
uip or roles create --name <name> --type <Tenant|Folder>
uip or roles update <role-key> [--add-permissions <names>] [--remove-permissions <names>]
uip or roles delete <role-key> -y
uip or roles users list <role-key> [options]
uip or roles users set <role-key> [--add-user-keys <keys>] [--remove-user-keys <keys>]
uip or roles user-roles list <principal-name> [--type <type>] [options]
uip or roles user-permissions list <username> [--folder-path <path> | --folder-key <key>]
uip or roles assign --user-key <key> --role-keys <keys> [--folder-path <path> | --folder-key <key>]

Verbo

Texto	Finalidade
permissions list	Listar nomes de permissões concedidas.
list	Listar funções no tenant.
get	Busca uma função com suas permissões concedidas.
create	Crie uma função (sem permissões) no escopo Tenant ou Folder .
update (alias edit)	Adicione ou remova permissões em uma função.
delete	Excluir uma função criada pelo usuário.
users list	Lista os usuários atribuídos a uma função.
users set	Adicione ou remova usuários em uma função (em massa).
user-roles list	Lista as atribuições de função completas de um principal (usuário, grupo, robô, máquina ou aplicativo externo) em tenant e cada pasta.
user-permissions list	Lista as permissões efetivas de um usuário, em todo o tenant ou no escopo de uma pasta.
assign	Atribua funções no nível da pasta a um usuário em uma pasta específica.

lista de permissões de uip ou funções

Liste cada nome de permissão concedida. Use esses nomes com roles update --add-permissions

Opções

Short	Long	Valor	Padrão	Description
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	Name asc	Classificação OData.

Exemplos

uip or roles permissions list --limit 200
uip or roles permissions list --output-filter 'Data[].Name'
uip or roles permissions list --output table

Formato dos dados (--output json)

{
  "Code": "PermissionList",
  "Data": [{ "Name": "Assets.Create" }, { "Name": "Assets.Delete" }]
}

uip ou lista de funções

Listar funções. Retorna chave (GUID), ID, nome, nome de exibição, tipo e se a função é editável. Use a chave de função com roles get, roles update ou roles users set.

Opções

Short	Long	Valor	Padrão	Description
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	Id desc	Classificação OData.

Exemplos

uip or roles list --limit 50
uip or roles list --output-filter "Data[?Type=='Tenant'].Name"
uip or roles list --output table

Formato dos dados (--output json)

{
  "Code": "RoleList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "ID": 1,
      "Name": "Administrator",
      "DisplayName": "Administrator",
      "Type": "Tenant",
      "IsEditable": false
    }
  ]
}

uip ou funções obter

Busca uma função com suas permissões concedidas.

Argumentos

Name	Required	Finalidade
<role-key>	sim	Chave de função (GUID). Use roles list para encontrá-lo.

Opções

Short	Long	Valor	Padrão	Description

Exemplos

uip or roles get a1b2c3d4-0000-0000-0000-000000000001
uip or roles get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Permissions'
uip or roles get a1b2c3d4-0000-0000-0000-000000000001 --output table

Formato dos dados (--output json)

{
  "Code": "Role",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "ID": 1,
    "Name": "Administrator",
    "DisplayName": "Administrator",
    "Type": "Tenant",
    "IsStatic": true,
    "IsEditable": false,
    "Permissions": "Assets.View, Assets.Create, Jobs.View"
  }
}

criação de uip ou funções

Crie uma função sem permissões. Após a criação, conceda permissões com roles update --add-permissions.

Opções

Short	Long	Valor	Padrão	Description
—	--name	text	necessário	Nome da função.
—	--type	Tenant | Folder	necessário	Tenant aplica-se a todo o tenant; Folder aplica-se dentro de pastas.

Exemplos

uip or roles create --name "Read Only" --type Tenant
uip or roles create --name "Folder Viewer" --type Folder
uip or roles create --name "Read Only" --type Tenant \
    --output-filter 'Data.Key'

Formato dos dados (--output json)

{
  "Code": "RoleCreated",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "ID": 10,
    "Name": "Read Only",
    "Type": "Tenant",
    "Status": "Created successfully"
  }
}

atualização de uip ou funções

Adicione ou remova permissões em uma função. Lê as permissões atuais, alterna isGranted para nomes em --add-permissions / --remove-permissions e salva. Novos nomes (ainda na função) são pesquisados no catálogo de permissões completo do tenant e adicionados.

edit é um alias registrado para esse verbo — uip or roles edit funciona de forma idêntica a uip or roles update.

Argumentos

Name	Required	Finalidade
<role-key>	sim	Chave de função (GUID).

Opções

Short	Long	Valor	Padrão	Description
—	--add-permissions	CSV de nomes	—	Permissões a conceder.
—	--remove-permissions	CSV de nomes	—	Permissões a revogar.

Pelo menos um dos --add-permissions ou --remove-permissions é necessário.

Exemplos

uip or roles update a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View,Jobs.View

uip or roles update a1b2c3d4-0000-0000-0000-000000000010 \
    --remove-permissions Jobs.Edit

uip or roles update a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View --output-filter 'Data.Status'

Formato dos dados (--output json)

{
  "Code": "RoleUpdated",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Updated successfully" }
}

exclusão de uip ou funções

Excluir uma função criada pelo usuário. As funções integradas (em que IsStatic=true) não podem ser removidas.

Argumentos

Name	Required	Finalidade
<role-key>	sim	Chave de função (GUID).

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Obrigatório. Confirma esta operação irreversível — a CLI nunca solicita.

Exemplos

uip or roles delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or roles delete a1b2c3d4-0000-0000-0000-000000000010 --yes \
    --output-filter 'Data.Status'

Formato dos dados (--output json)

{
  "Code": "RoleDeleted",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

lista de usuários uip ou funções

Lista os usuários atribuídos a uma função.

Argumentos

Name	Required	Finalidade
<role-key>	sim	Chave de função (GUID).

Opções

Short	Long	Valor	Padrão	Description
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.

Exemplos

uip or roles users list a1b2c3d4-0000-0000-0000-000000000001
uip or roles users list a1b2c3d4-0000-0000-0000-000000000001 --limit 200
uip or roles users list a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data[].UserName'

Formato dos dados (--output json)

{
  "Code": "RoleUserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "ID": 101,
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User"
    }
  ]
}

usuários uip ou funções definidos

Adicione ou remova usuários em uma função (em massa). Forneça --add-user-keys, --remove-user-keys ou ambos. É necessário pelo menos um. Apenas adicionado/subtrativo — a associação existente não nomeada em nenhum sinalizador permanece intacta (diferente de users assign-roles, que substitui a lista completa).

Argumentos

Name	Required	Finalidade
<role-key>	sim	Chave de função (GUID).

Opções

Short	Long	Valor	Padrão	Description
—	--add-user-keys	CSV de GUIDs	—	Usuários a adicionar.
—	--remove-user-keys	CSV de GUIDs	—	Usuários a serem removidos.

Exemplos

uip or roles users set a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-0000-0000-0000-000000000001

uip or roles users set a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001,d4e5f6a7-…-002 \
    --remove-user-keys d4e5f6a7-…-099

uip or roles users set a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001 --output-filter 'Data.Added'

Formato dos dados (--output json)

{
  "Code": "RoleUsersUpdated",
  "Data": {
    "RoleKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "Added": 1,
    "Removed": 0,
    "Status": "Updated successfully"
  }
}

uip ou funções usuário-funções lista

Liste todas as atribuições de função para um principal — um usuário, grupo de diretórios, robô de diretório, máquina ou aplicativo externo — no tenant e em cada pasta. Útil para auditar o perfil de acesso completo de um principal.

Argumentos

Name	Required	Finalidade
<principal-name>	sim	Nome de usuário, nome do grupo, nome do robô, nome da máquina ou nome do aplicativo externo a ser pesquisado.

Opções

Short	Long	Valor	Padrão	Description
—	--type	User | Group | Robot | Machine | ExternalApplication	User	Tipo principal. As grafias DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication também são aceitas como alias.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.

Exemplos

uip or roles user-roles list [e-mail]
uip or roles user-roles list "MRS Developers" --type Group
uip or roles user-roles list [e-mail] \
    --output-filter "Data[?Scope=='Folder']"

Formato dos dados (--output json)

{
  "Code": "UserRoleList",
  "Data": [
    { "Scope": "Tenant", "FolderPath": "", "Role": "Administrator" },
    { "Scope": "Folder", "FolderPath": "Shared", "Role": "Folder Administrator" }
  ]
}

lista de permissões de usuário de uip ou funções

Lista as permissões efetivas de um usuário. Sem uma opção de pasta, mostra funções e permissões no nível do tenant; com --folder-path/--folder-key, mostra as funções e permissões concedidas nessa pasta específica. Retorna a união desduplicada de permissões concedidas por todas as funções correspondentes.

Argumentos

Name	Required	Finalidade
<username>	sim	Nome de usuário a ser pesquisado.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Exiba as permissões no nível da pasta para esta pasta em vez do nível do tenant.
—	--folder-key	GUID	—	Pasta alternativa a --folder-path.

Exemplos

uip or roles user-permissions list [e-mail]

uip or roles user-permissions list [e-mail] --folder-path "Shared"

Formato dos dados (--output json)

Nível do tenant:

{
  "Code": "UserPermissionList",
  "Data": {
    "Roles": ["Administrator"],
    "Permissions": ["Jobs.View", "Assets.Create"]
  }
}

Com escopo de pasta:

{
  "Code": "UserPermissionList",
  "Data": {
    "FolderPath": "Shared",
    "Roles": ["Folder User"],
    "Permissions": ["Jobs.View", "Assets.View"]
  }
}

uip ou atribuição de funções

Atribuir funções no nível da pasta a um usuário. Use apenas funções do tipo Pasta. Requer --folder-path ou --folder-key.

Observação:

CUIDADO — destrutivo em funções. O servidor substitui toda a lista de funções no nível da pasta do usuário para a pasta de destino pelas chaves passadas por meio --role-keys. As funções que não estão na carga são removidas silenciosamente. Para preservar as funções de pasta existentes, leia-as primeiro com roles user-roles list <principal-name> --type <type> e passe a união completa desejada para --role-keys. Para associação cumulativa de função no nível do tenant em uma função, use roles users set em vez disso.

Opções

Short	Long	Valor	Padrão	Description
—	--user-key	GUID	necessário	Chave do usuário.
—	--role-keys	CSV de GUIDs	necessário	GUIDs de função a serem atribuídos na pasta.
—	--folder-path	Path	—	Pasta de destino. Forneça esta ou --folder-key.
—	--folder-key	GUID	—	Pasta de destino.

Exemplos

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --folder-path "Shared"

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-…-002,a1b2c3d4-…-003 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --folder-path "Shared" --output-filter 'Data.Status'

Formato dos dados (--output json)

{
  "Code": "PermissionsAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}

Códigos de saída

Consulte Códigos de saída. Nenhuma substituição específica do verbo.

Comandos relacionados

• uip or users — encontrar chaves de usuário; users assign-roles para atribuições de função no nível do tenant.
• uip or folders — localize chaves de pasta para roles assign.

Veja também

• Opções globais.
• Autenticação.