automation-cloud
latest
false
- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
Guia de API da UiPath Automation Cloud
Última atualização 5 de mai de 2026
Recupera a lista de usuários que adquiriram licenças de um grupo específico. Requer um aplicativo externo com a política OrganizationAdmin ou LicenseRead .
Ponto de Extremidade da API
GET {accessURL}/{organizationName}/lease_/api/account/{organizationId}/user-license/group/{groupId}/bulk-users
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/ |
Cabeçalhos de solicitação.
--header 'Authorization: Bearer {access_token}'
--header 'Authorization: Bearer {access_token}'
Parâmetros do caminho
| Parâmetro do caminho | Tipo de dados | Description |
|---|---|---|
organizationId (obrigatório) | Guid | A ID da organização na qual seu locatário reside. |
groupId (obrigatório) | String | O ID do grupo. |
Parâmetros de Consulta
Todos os parâmetros de consulta são opcionais e usados para paginação.
| Parâmetro | Tipo | Description |
|---|---|---|
skip | Número inteiro | Deslocamento na lista de resultados. |
top | Número inteiro | Número de resultados a serem retornados. Máximo: 50. |
sortBy | String | Nome do campo para fazer o pedido. Use os nomes de propriedades UpperCanelCase do C#. |
sortOrder | String | Defina a direção. Valores aceitos: asc, desc. |
Resposta
200 OK - retorna as regras de licença e a configuração de cota para todos os grupos. 404 - a organização não existe
[
{
"results": [
{
"id": "string",
"email": "string",
"name": "string",
"surname": "string",
"displayName": "string",
"lastInUse": "2026-01-01T00:00:00Z",
"userBundleLicenses": ["string"],
"orphan": false
}
],
"totalCount": 0
}
]
[
{
"results": [
{
"id": "string",
"email": "string",
"name": "string",
"surname": "string",
"displayName": "string",
"lastInUse": "2026-01-01T00:00:00Z",
"userBundleLicenses": ["string"],
"orphan": false
}
],
"totalCount": 0
}
]
Exemplo de solicitação
[
curl --location --request GET 'https://cloud.uipath.com/my-org/lease_/api/account/1234/user-license/group/group-01/bulk-users' --header 'Authorization: Bearer {access_token}'
]
[
curl --location --request GET 'https://cloud.uipath.com/my-org/lease_/api/account/1234/user-license/group/group-01/bulk-users' --header 'Authorization: Bearer {access_token}'
]