Directorio de búsqueda

PuntoFinal de la API de Search Directory para encontrar usuarios, grupos o aplicaciones por string de prefijo dentro de una organización en Test Cloud.

Busca en el directorio entidades (usuarios, grupos o aplicaciones) que coincidan con una cadena de prefijo, en función del ID de la organización.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	https://cloud.uipath.com/
Test Cloud Sector Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

Ámbitos

Necesita los siguientes ámbitos:

• PM.Directorio

Solicitar encabezados.

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

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.

Parámetros de ruta

Parámetros de ruta	Tipo de datos	Descripción
partitionGlobalId (obligatorio)	Cadena (GUID)	El ID de la organización en la que buscar.

Parámetros de consulta

Parámetros de consulta	Tipo de datos	Descripción
startsWith (obligatorio)	Cadena	La cadena de prefijo que se buscará. Los resultados coincidirán con las entidades cuyo nombre, correo electrónico o nombre para mostrar comience con este valor.
entityType (opcional)	Cadena	El tipo de entidad de directorio que se buscará. Valores válidos: User, Group, Application. No se puede utilizar junto con sourceFilter.
sourceFilter (opcional)	Matriz de Strings	Filtra los resultados por origen. Valores válidos: LocalUsers, DirectoryUsers, LocalGroups, DirectoryGroups, RobotAccounts, Applications. No se puede utilizar junto con entityType.
scope (opcional)	Cadena	Ámbito opcional utilizado para entidades en el directorio activo.

Respuesta

200 OK

Devuelve una lista de entidades de directorio que coinciden con los criterios de búsqueda.

[
    {
        "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

Se devuelve cuando se proporcionan tanto entityType como sourceFilter , o cuando faltan los parámetros necesarios.

Solicitud de ejemplo

Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.

• Su {baseURL} es: https://cloud.uipath.com/{organizationName}/identity_
• Tu {access_token} es: 1234 (para consideraciones de longitud)
• El {partitionGlobalId} es: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Desea buscar usuarios cuyo nombre comience con "john".

La llamada debe parecerse al siguiente ejemplo (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'

Aquí está el body de respuesta de una llamada correcta:

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