- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Solicitações de itens de fila
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
Guia da API do Orchestrator
Solicitações de usuários
- 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)
eGetRoles(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}
.
O exemplo a seguir permite alterar o idioma do usuário com o ID 749 para japonês.
Postar
https://{yourDomain}/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture
COLOCAR
https://{yourDomain}/odata/Users(13)
{
"RobotProvision": {
"UserName": "uipath\\john.smith",
"RobotId": 53,
"RobotType": "Development",
"ExecutionSettings": {}
}
}
{
"RobotProvision": {
"UserName": "uipath\\john.smith",
"RobotId": 53,
"RobotType": "Development",
"ExecutionSettings": {}
}
}
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
https://{yourDomain}/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles
{
"roleIds": [
1,3
]
}
{
"roleIds": [
1,3
]
}
Exemplo
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://{yourDomain}/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json"
-d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"
https://https://{yourDomain}/swagger
)
Aqui está um procedimento de exemplo de como atribuir funções a uma conta:
-
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.
- Anote os IDs das funções que deseja atribuir.
-
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.
- Anote os IDs das contas às quais você deseja atribuir funções.
-
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.
- Excluindo um usuário
- Cabeçalhos de solicitação.
- Código de resposta
- Mudando o idioma
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Provisionando um robô para um usuário
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Atribuição de funções
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Passo a passo