UIP ou funções

uip or roles gerencia funções e permissões do Orchestrator (RBAC). As permissões de pacotes de funções e são atribuídas aos usuários no nível do tenant (globalmente) ou da pasta (com escopo). Os verbos nessa página cobrem as funções e suas permissões, associação ao usuário da função 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 <verb> [options]

Verbo

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

uip ou funções list-permissions

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

Opções

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

Exemplos

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

Formato dos dados (--output json)

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

uip ou funções lista-funções

Listar funções. Retorna chave (GUID), ID, nome, nome de exibição, tipo e se a função é editável.

Opções

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

Exemplos

uip or roles list-roles --limit 50
uip or roles list-roles --output-filter "Data[?Type=='Tenant'].Name"
uip or roles list-roles --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 get-role

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

Argumentos

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

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001
uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Permissions'
uip or roles get-role 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"
  }
}

uip ou funções criar-função

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

Opções

Short	Long	Valor	Padrão	Description
—	--name	text	necessário	Nome da função.
—	--type	ENUM	necessário	Tenant (aplica-se a todo o tenant) ou Folder (aplica-se dentro de pastas).
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

uip or roles create-role --name "Read Only" --type Tenant
uip or roles create-role --name "Folder Viewer" --type Folder
uip or roles create-role --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"
  }
}

uip ou funções edit-role

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.

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.
-t	--tenant	name	padrão da sessão	Substituir o tenant.

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

Exemplos

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

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

uip or roles edit-role 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" }
}

uip ou funções Delete-role

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

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

Formato dos dados (--output json)

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

uip ou funções list-role-users

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.

Exemplos

uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001
uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001 --limit 200
uip or roles list-role-users 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"
    }
  ]
}

uip ou funções set-role-users

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.

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.
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

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

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

uip or roles set-role-users 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 listar-usuário-funções

Lista todas as atribuições de função para um usuário no tenant e em cada pasta. Útil para auditar o perfil de acesso completo de um usuário.

Argumentos

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

Opções

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

Exemplos

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

Formato dos dados (--output json)

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

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.

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.
-t	--tenant	name	padrão da sessão	Substituir o tenant.

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.