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 manages Orchestrator roles and permissions (RBAC). Roles bundle permissions and are assigned to users, groups, robots, machines, or external applications at either the tenant (globally) or folder (scoped) level. Verbs on this page cover roles and their permissions, role-user membership, principal-level role/permission inspection, and folder-level assignments. For tenant-level role assignment per user, see users assign-roles in 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	List a principal's (user, group, robot, machine, or external app) complete role assignments across tenant and every folder.
user-permissions list	List a user's effective permissions, tenant-wide or scoped to one folder.
assign	Atribua funções no nível da pasta a um usuário em uma pasta específica.

uip or roles permissions list

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 or roles list

List roles. Returns key (GUID), ID, name, display name, type, and whether the role is editable. Use the role key with roles get, roles update, or 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 or roles get

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

Argumentos

Name	Required	Finalidade
<role-key>	sim	Role key (GUID). Use roles list to find it.

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

uip or roles create

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 applies across the tenant; Folder applies within folders.

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

uip or roles update

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 is a registered alias for this verb — uip or roles edit works identically to 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" }
}

uip or roles delete

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	—	Required. Confirms this irreversible operation — the CLI never prompts.

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

uip or roles users list

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

uip or roles users set

Add or remove users on a role (bulk). Provide --add-user-keys, --remove-user-keys, or both. At least one is required. Additive/subtractive only — existing membership not named in either flag is left untouched (unlike users assign-roles, which replaces the full list).

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 or roles user-roles list

List all role assignments for a principal — a user, directory group, directory robot, machine, or external application — across the tenant and every folder. Useful for auditing a principal's full access profile.

Argumentos

Name	Required	Finalidade
<principal-name>	sim	Username, group name, robot name, machine name, or external-app name to look up.

Opções

Short	Long	Valor	Padrão	Description
—	--type	User | Group | Robot | Machine | ExternalApplication	User	Principal type. The DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication spellings are also accepted as aliases.
-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" }
  ]
}

uip or roles user-permissions list

List a user's effective permissions. Without a folder option, shows tenant-level roles and permissions; with --folder-path/--folder-key, shows the roles and permissions granted in that specific folder instead. Returns the deduplicated union of permissions granted by all matching roles.

Argumentos

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

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Show folder-level permissions for this folder instead of tenant-level.
—	--folder-key	GUID	—	Folder alternative to --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)

Tenant-level:

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

Folder-scoped:

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

CAUTION — destructive on roles. The server replaces the user's entire folder-level role list for the target folder with the keys passed via --role-keys. Roles not in the payload are silently removed. To preserve existing folder roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. For additive tenant-level role membership on a role, use roles users set instead.

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.