Solicitações de usuários

Observação:

• As solicitações GET para os endpoints /odata/Users ou /odata/Users({}) retornam um domínio vazio para usuários do AD.
• As solicitações GetOrganizationUnits(Id) e GetRoles(Id) apenas retornam pastas e funções definidas explicitamente para um usuário autoprovisionado. Aquelas herdadas da configuração de grupo podem ser recuperadas por meio do endpoint /api/DirectoryService/GetDirectoryPermissions?userId={userId}.

Excluindo um usuário

Excluir

{OrchestratorURL}/odata/Users(446)

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Código de resposta

204 Sem conteúdo

Mudando o idioma

O exemplo a seguir permite alterar o idioma do usuário com o ID 749 para japonês.

Postar

{OrchestratorURL}/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
    "culture": "ja"
}

Código de resposta

200 OK

Provisionando um robô para um usuário

COLOCAR

{OrchestratorURL}/odata/Users(13)

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}

Código de resposta

200 OK

Atribuição de funções

Você pode usar esse terminal para atribuir uma ou mais funções ao ID do usuário especificado, que pode ser o ID de um grupo, uma conta de usuário ou uma conta de robô.

Postar

{OrchestratorURL}/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
  "roleIds": [
    1,3
  ]
}

Exemplo

A solicitação abaixo atualiza a conta ou grupo com o ID do usuário 9 substituindo suas funções atribuídas pelas funções que possuem IDs 1 e 3.

Funções antes da solicitação	Funções após solicitação	Alterações
Sem funções	1 e 3	As funções com IDs 1 e 3 foram atribuídas.
Funções com IDs 1 e 2	1 e 3	A função com ID 2 foi removida e a função com ID 3 foi atribuída.
Função com ID 2	1 e 3	A função com ID 2 foi removida e as funções com IDs 1 e 3 foram designadas.

cURL

curl -X POST "https://{server}/{OrgName}/{TenantName}/orchestrator_/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"

Swagger UI (disponível em https://<OrchestratorURL>/swagger)

Passo a passo

Aqui está um procedimento de exemplo de como atribuir funções a uma conta:

1. Faça uma solicitação GET em /odata/Roles para recuperar a lista de funções.

   Você pode usar qualquer tipo de filtro compatível com OData, se necessário.

2. Anote os IDs das funções que deseja atribuir.
3. Faça uma solicitação GET em /odata/Users para recuperar a lista de contas.

   A lista inclui grupos, contas de usuário e contas de robô.

   Você pode usar qualquer tipo de filtro compatível com OData, se necessário.

4. Anote os IDs das contas às quais você deseja atribuir funções.
5. Faça uma solicitação POST para /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles para cada conta à qual deseja atribuir funções.
   • {key} é um único ID de conta para a conta à qual você deseja atribuir funções
   • {roleID} é um único ID de função para a função que você deseja atribuir; você pode listar vários IDs, separados por uma vírgula.