UiPath Documentation
automation-cloud
latest
false
Guia de API da UiPath Automation Cloud

Atualizar conta de robô

Ponto de extremidade PUT para atualizar as informações da conta do robô no Automation Cloud, incluindo escopos necessários e cabeçalhos de solicitação.

Obtém informações sobre o grupo de IAM especificado.

Ponto de Extremidade da API​

PUT {accessURL}/{organizationName}/identity_/api/Setting

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud PlatformURL de acesso
Automation Cloudhttps://cloud.uipath.com/
Automation Cloud Setor públicohttps://govcloud.uipath.us/
Automation Cloud dedicadohttps://{customURL}.dedicated.uipath.com/

Escopos​

Requer os seguintes escopos:

  • PM.RobotAccount
  • PM.RobotAccount.Write

Cabeçalhos de solicitação.​

--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer <your-access-token>'\
--header 'Content-Type: application/json'
Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Parâmetros do caminho​

ParâmTipo de dadosDescription
robotAccountId (obrigatório)StringA ID da conta de Robot que você deseja atualizar.

Corpo da Solicitação​

O corpo da solicitação contém a ID da organização à qual a conta de Robot pertence e as informações que você deseja atualizar, como associações a grupos.

{
  "partitionGlobalId": "string",
  "displayName": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ]
}
{
  "partitionGlobalId": "string",
  "displayName": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ]
}

Resposta​

200 OK​

O grupo personalizado é atualizado com as informações que você forneceu.

Exemplo de solicitação​

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

  • Seu {baseURL} é: https://cloud.uipath.com/{organizationName}/identity_
  • Seu <your-access-token> é: 1234 (para considerações de comprimento).
  • O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6
  • Você deseja atribuir a conta de Robot com a ID 88-uv à ID do grupo alumni-02.

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request PUT 'https://cloud.uipath.com/{organizationName}/identity_/api/RobotAccount/88-uv' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "Roby",
    "groupIDsToAdd": [
        "alumni-02"
    ],
    "groupIDsToRemove": []
}'
curl --location --request PUT 'https://cloud.uipath.com/{organizationName}/identity_/api/RobotAccount/88-uv' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "Roby",
    "groupIDsToAdd": [
        "alumni-02"
    ],
    "groupIDsToRemove": []
}'

Aqui está a resposta de uma chamada bem-sucedida:

{
    "id": "88-uv",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T12:16:16.6492925",
    "lastLoginTime": null,
    "groupIds": [
        "alumni-02",
        "gryff-01"
    ]
}
{
    "id": "88-uv",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T12:16:16.6492925",
    "lastLoginTime": null,
    "groupIds": [
        "alumni-02",
        "gryff-01"
    ]
}

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades