Diretório de Busca

Pesquisa o diretório em busca de entidades (usuários, grupos ou aplicativos) que correspondam a uma string de prefixo com base no ID da organização.

Ponto de Extremidade da API

GET {accessURL}/{organizationName}/identity_/api/Directory/Search/{partitionGlobalId}

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.Diretório

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Observação:

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 (GUID)	O ID da organização dentro da qual pesquisar.

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description
startsWith (obrigatório)	String	A string de prefixo a ser pesquisada. Os resultados corresponderão a entidades que têm o nome, email ou nome de exibição iniciados por este valor.
entityType (opcional)	String	O tipo de entidade do diretório a ser pesquisado. Valores válidos: User, Group, Application. Não pode ser usado com sourceFilter.
sourceFilter (opcional)	Matriz de strings	Filtra os resultados por origem. Valores válidos: LocalUsers, DirectoryUsers, LocalGroups, DirectoryGroups, RobotAccounts, Applications. Não pode ser usado com entityType.
scope (opcional)	String	Escopo opcional usado para entidades no diretório ativo.

Resposta

200 OK

Retorna uma lista de entidades do diretório correspondentes aos critérios de pesquisa.

[
    {
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "identityName": "[e-mail]",
        "displayName": "John Doe",
        "email": "[e-mail]",
        "type": "User",
        "objectType": "DirectoryUser"
    },
    {
        "source": "aad",
        "identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "identityName": "Engineering Team",
        "displayName": "Engineering Team",
        "email": null,
        "type": "Group",
        "objectType": "DirectoryGroup"
    }
]

400 Bad Request

Retornado quando entityType e sourceFilter são fornecidos ou quando os parâmetros necessários estão ausentes.

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 pesquisar usuários cujo nome começa com "john".

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/Search/3fa85f64-5717-4562-b3fc-2c963f66afa6?startsWith=john&entityType=User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Aqui está o body da resposta de uma chamada bem-sucedida:

[
    {
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "identityName": "[e-mail]",
        "displayName": "John Doe",
        "email": "[e-mail]",
        "type": "User",
        "objectType": "DirectoryUser"
    }
]