- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
Guia de API da UiPath Automation Cloud
Returns a paged list of members belonging to a specific local group, based on the organization, group ID, and optional paging parameters.
Ponto de Extremidade da API
GET {accessURL}/{organizationName}/identity_/api/Group/{partitionGlobalId}/{groupId}/Members
Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:
| Cloud Platform | URL de acesso |
|---|---|
| Automation Cloud | https://cloud.uipath.com/ |
| Automation Cloud Setor público | https://govcloud.uipath.us/ |
| Automation Cloud dedicado | https://{customURL}.dedicated.uipath.com/ |
Escopos
Requer os seguintes escopos:
- PM.Group
- PM.Group.Read
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.
Parâmetros do caminho
| Parâmetro do caminho | Tipo de dados | Description |
|---|---|---|
partitionGlobalId (obrigatório) | String | A ID da organização que contém o grupo desejado. |
groupId (obrigatório) | String | The ID of the group whose members you want to retrieve. |
Parâmetros de Consulta
| Parâmetro de consulta | Tipo de dados | Description |
|---|---|---|
top | Número inteiro | The number of records to return. Default is 10. Range is 0 to 1000. |
skip | Número inteiro | The number of records to skip. Default is 0. |
Resposta
200 OK
A paged list of group members is returned, along with the total count.
404 Não encontrado
The specified group was not found in the given organization.
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 - O
{groupId}é:2512
A chamada deve ser semelhante ao seguinte exemplo (cURL):
curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Group/3fa85f64-5717-4562-b3fc-2c963f66afa6/2512/Members?top=10&skip=0' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Group/3fa85f64-5717-4562-b3fc-2c963f66afa6/2512/Members?top=10&skip=0' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
Aqui está o body da resposta de uma chamada bem-sucedida:
{
"totalCount": 2,
"results": [
{
"id": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"type": 0
},
{
"id": "a4c2e8b1-7d3f-4a91-b5e2-6f8d9c0e1a3b",
"type": 0
}
]
}
{
"totalCount": 2,
"results": [
{
"id": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
"type": 0
},
{
"id": "a4c2e8b1-7d3f-4a91-b5e2-6f8d9c0e1a3b",
"type": 0
}
]
}