- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
- Limites de taxa de API para o Identity Server
- Recuperação do partiçãoGlobalId para uso da API
- Alertas
- Obtenha acesso efetivo no nível da organização
- Exportar atribuições de função do usuário
Exportar atribuições de função do usuário
Consulte a API de exportação de acesso para gerar um relatório de todas as funções e atribuições de função em produtos UiPath.
Exporta um relatório contendo todas as funções e atribuições de funções associadas a qualquer produto da UiPath®.
Coleção do Postman
Para usar a API de exportação de acesso a verificação, baixe e importe a coleção Postman em seu aplicativo Postman.
Ao usar a coleção do Postman, você pode encontrar erros quando a resposta for maior que 50 MB. Essa configuração no Postman pode ser alterada (nas versões Desktop e Web) navegando até Configurações, selecionando Geral e definindo o Tamanho máximo da resposta como zero MB.
Ponto de Extremidade da API
GET {accessURL}/<yourorgname>/pap_/api/userroleassignments/export
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
This endpoint does not check token scopes or audience. Access depends only on the permission of the caller. The calling user or external application must have permission to export role assignments at the organization level (for example, Organization Administrator).
Cabeçalhos de solicitação.
--header 'Authorization: Bearer <your-access-token>'\
--header 'Authorization: Bearer <your-access-token>'\
To obtain the <your-access-token>, ensure you authenticate through one of the methods described in Authentication methods.
The calling user or external application must have permission to export role assignments at the organization level. Otherwise, the call returns 403 Forbidden.
Parâmetros de Consulta
| Parâmetro de consulta | Tipo de dados | Description |
|---|---|---|
exportoutputtype(obrigatório) | String | Especifique um dos dois formatos de arquivo disponíveis: .json ou .csv |
|
(obrigatório) | String |
|
Resposta
200 OK
O relatório de funções de usuário e atribuições de função é baixado para sua máquina, no formato .json ou .csv .
Exemplo de solicitação
curl --location -- request GET 'https://cloud.uipath.com/acmeorg/pap_/api/userroleassignments/export?exportoutputtype=json' \
--header 'Authorization: Bearer {your token}
curl --location -- request GET 'https://cloud.uipath.com/acmeorg/pap_/api/userroleassignments/export?exportoutputtype=json' \
--header 'Authorization: Bearer {your token}
O seguinte corpo de resposta representa uma recuperação bem-sucedida de função de usuário e atribuição de função:
[
{
"Id": "34ecc3f3-a582-4cad-9889-120d7a3ffd62",
"RoleUniqueName": "DOCUMENTUNDERSTANDING.DU VIEWER",
"RoleDescription": "Can view all the entities but has not rights to edit or delete them.",
"SecurityPrincipalId": "cdc34b5b-77d2-4ae1-9744-209d21ce557d",
"RoleAssignmentType": "BuiltIn",
"RoleType": "BUILTIN",
"Scope": "/",
"OrganizationId": "feb0dd79-85b6-483b-b297-0e49a1aa5b7d",
"TenantId": null,
"CreatedBy": "7f36fcc2-b822-430b-ae30-5ecfbacac186",
"CreatedOn": "2023-03-30T08:30:04.9346766+00:00"
},
...
]
[
{
"Id": "34ecc3f3-a582-4cad-9889-120d7a3ffd62",
"RoleUniqueName": "DOCUMENTUNDERSTANDING.DU VIEWER",
"RoleDescription": "Can view all the entities but has not rights to edit or delete them.",
"SecurityPrincipalId": "cdc34b5b-77d2-4ae1-9744-209d21ce557d",
"RoleAssignmentType": "BuiltIn",
"RoleType": "BUILTIN",
"Scope": "/",
"OrganizationId": "feb0dd79-85b6-483b-b297-0e49a1aa5b7d",
"TenantId": null,
"CreatedBy": "7f36fcc2-b822-430b-ae30-5ecfbacac186",
"CreatedOn": "2023-03-30T08:30:04.9346766+00:00"
},
...
]
A tabela a seguir descreve os campos de cabeçalho do arquivo exportado:
| Campo | Description |
|---|---|
| Id | O identificador exclusivo da atribuição de função. |
| RoleName | O nome da função conforme exibido na interface. Por exemplo, Folder Administrator |
| IdDaFunção | O identificador exclusivo da função. |
| DescriçãoDaFunção | A descrição da função, conforme exibido na interface. Por exemplo, Folder Administrator Por exemplo, Folder Administrator |
| Tipo de função | O tipo da função, conforme definido pelo usuário ou o sistema:
|
| TipoDeAtribuiçãoDeFunção | O tipo de atribuição da função quando foi criada, que pode ser uma das duas opções a seguir:
|
| Escopo | O escopo é um nível específico na hierarquia organizacional que serve como limite para certas ações, permissões e objetos. Um escopo pode ser uma das seguintes opções hierárquicas, representados como IDs:
|
| EscopoComNomesDeExibição | O escopo é um nível específico na hierarquia organizacional que serve como limite para certas ações, permissões e objetos. Um escopo pode ser uma das seguintes opções hierárquicas:
|
| ServiceName | O nome do serviço da UiPath ao qual a função pertence. |
| IdPrincipalDeSegurança | O identificador exclusivo da identidade de um usuário, grupo etc. |
| TipoPrincipalDeSegurança | O tipo de identidade de um usuário, grupo ou robô. |
| EmailPrincipalDeSegurança | O e-mail do usuário Este campo fica em branco caso a identidade não seja um usuário. |
| NomeDeExibiçãoPrincipalDeSegurança | O nome da identidade. Este campo fica em branco no caso de usuários do diretório. |
| HerdadoDoNomeDoGrupo | O nome do grupo do qual a atribuição de função é herdada. |
| HerdadoDoIdDoGrupo | Identificador do grupo do qual a atribuição de função é herdada. |
| NomeDoTenant | O nome do tenant em que a atribuição é feita. Este campo fica em branco no caso de atribuições no nível da organização. |
| NomeDaOrganização | O nome da organização em que a atribuição é feita. |
| OrganizationId | O identificador da organização em que a atribuição é feita. |
| TenantId | O identificador do tenant em que a atribuição é feita. Este campo fica em branco no caso de atribuições no nível da organização. |
| CreatedBy | O identificador exclusivo do usuário que cria a atribuição. |
| CriadoPorNomeDeExibição | O nome do usuário que cria a atribuição. |
| Criado Em | O carimbo de data/hora de quando a função foi atribuída. |
| NomeDaPasta | O nome da pasta associada à atribuição. |
| FolderKey | O identificador exclusivo da pasta associada à atribuição. |
| ProjectId | O ID do projeto (por exemplo, Document Understanding ou IXP) associado à atribuição. |