- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma

Guia da API do Test Cloud
Criar um novo grupo local
Cria um novo grupo local na ID da organização especificada e adiciona os usuários indicados a ela.
Ponto de Extremidade da API
POST {accessURL}/{organizationName}/identity_/api/Group
Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:
| Cloud Platform | URL de acesso |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud para o Setor Público | https://govcloud.uipath.us/ |
| Test Cloud Dedicado | https://{customURL}.dedicated.uipath.com/ |
Escopos
Requer os seguintes escopos:
- PM.Group
- PM.Group.Write
Cabeçalhos de solicitação.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos aqui.
Corpo da Solicitação
O corpo da solicitação contém a ID da organização à qual você deseja adicionar o grupo e, opcionalmente, os usuários que você deseja adicionar como membros no novo grupo.
{
"partitionGlobalId": "string",
"id": "string",
"name": "string",
"directoryUserMemberIDs": [
"string", "string"
]
}
{
"partitionGlobalId": "string",
"id": "string",
"name": "string",
"directoryUserMemberIDs": [
"string", "string"
]
}
Resposta
201 Successful
O grupo personalizado é criado nos organização indicados e obtém um ID.
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
{access_token}é:1234(para considerações de comprimento). - O
{partitionGlobalId}é:3fa85f64-5717-4562-b3fc-2c963f66afa6 - Você deseja nomear o grupo:
"Gryffindors" - Você deseja adicionar os usuários Ron, Harry e Hermione ao grupo. Esse usuários têm as seguintes IDs de usuários:
- Identificador do usuário Ron:
ron-0103 - Identificador do usuário Luna:
har-3107 - Identificador do usuário Hermione:
her-1909
- Identificador do usuário Ron:
A chamada deve ser semelhante ao seguinte exemplo (cURL):
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"partitionGlobalId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"Gryffindors",
"id": "gryff-01",
"directoryUserMemberIDs":
["ron-0103", "har-3107", "her-1909"]
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"partitionGlobalId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"Gryffindors",
"id": "gryff-01",
"directoryUserMemberIDs":
["ron-0103", "har-3107", "her-1909"]
}'
Aqui está a resposta de uma chamada bem-sucedida:
{
"id": "gryff-01",
"name": "Gryffindors",
"displayName": "Gryffindors",
"type": 1,
"creationTime": "2021-10-19T15:37:49.1853184",
"lastModificationTime": null,
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Hermione",
"lastName": "Granger",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Hermione Granger",
"source": "local",
"identifier": "her-1909",
"name": "Hermione",
"email": "hermione@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Harry",
"lastName": "Potter",
"jobTitle": ""student"",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Harry Potter",
"source": "local",
"identifier": "har-3107",
"name": "Harry",
"email": "harry@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Ron",
"lastName": "Weasley",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Ron Weasley",
"source": "local",
"identifier": "ron-0103",
"name": "Ron",
"email": "ron@hogwarts.com"
}
]
}
{
"id": "gryff-01",
"name": "Gryffindors",
"displayName": "Gryffindors",
"type": 1,
"creationTime": "2021-10-19T15:37:49.1853184",
"lastModificationTime": null,
"members": [
{
"objectType": "DirectoryUser",
"firstName": "Hermione",
"lastName": "Granger",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Hermione Granger",
"source": "local",
"identifier": "her-1909",
"name": "Hermione",
"email": "hermione@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Harry",
"lastName": "Potter",
"jobTitle": ""student"",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Harry Potter",
"source": "local",
"identifier": "har-3107",
"name": "Harry",
"email": "harry@hogwarts.com"
},
{
"objectType": "DirectoryUser",
"firstName": "Ron",
"lastName": "Weasley",
"jobTitle": "student",
"companyName": "Hogwarts",
"city": "London",
"department": "magic",
"displayName": "Ron Weasley",
"source": "local",
"identifier": "ron-0103",
"name": "Ron",
"email": "ron@hogwarts.com"
}
]
}