Exportar atribuições de função do usuário

Ponto de extremidade da API para exportar um relatório de todas as funções e atribuições de funções associadas a produtos da UiPath no Test Cloud.

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.

Observação:

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
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 escopos de usuários no nível de plataforma.
• Esse ponto de extremidade requer um token de acesso do usuário ou um token S2S compatível.
• Tokens apenas de aplicativos (fluxo de credenciais do cliente) que usam escopos de aplicativos não são compatíveis e resultarão em uma resposta 403 Forbidden.
• Ao configurar um aplicativo externo, certifique-se de que:
  • Os escopos solicitados sejam escopos de usuários, não escopos de aplicativos.
  • O token seja gerado por meio de um fluxo de autenticação de usuário (por exemplo, fluxo de código de autorização) ou por meio de uma configuração S2S aprovada.

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'\

Observação:

O token de acesso deve ser:

• Um token de acesso de usuário ou
• Um token S2S compatível. Os tokens gerados usando o fluxo de credenciais do cliente com escopos de aplicativos não são compatíveis com esse ponto de extremidade.

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
expandgroupmemberships (obrigatório)	String	true - permite a expansão das associações de grupos do AAD na resposta. false ou ausente - os membros do AAD que fazem parte de grupos locais não ficam visíveis no relatório.

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}

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"
    },
...
]

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: Personalizado : função definida por um usuário. Integrado : função presente por padrão do portal de administração.
TipoDeAtribuiçãoDeFunção	O tipo de atribuição da função quando foi criada, que pode ser uma das duas opções a seguir: Personalizado : atribuição feita pelo usuário. Integrado : atribuição feita por padrão no portal de Administração.
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: Organização Tenant Serviço Folder
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: Organização Tenant Serviço Folder
ServiceName	O nome do serviço da UiPath ao qual a função pertence.
IdPrincipalDeSegurança	O identificador exclusivo para a identidade de um usuário, grupo ou outra identidade.
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.