# Resolve Directory Entity by Name

> API endpoint that resolves a single directory entity by name and type within a specified organization.

Resolves a single directory entity by its name and type, based on the organization ID.

## API Endpoint

`POST` `{accessURL}/{organizationName}/identity_/api/Directory/ResolveByName/{partitionGlobalId}`

Replace `{accessURL}` in all endpoint paths with the base URL for your cloud platform:

| Cloud platform | Access URL |
| --- | --- |
| Automation Cloud | `https://cloud.uipath.com/` |
| Automation Cloud Public Sector | `https://govcloud.uipath.us/` |
| Automation Cloud Dedicated | `https://{customURL}.dedicated.uipath.com/` |

## Scopes

Requires the following scopes:

* PM.Directory

## Request Headers

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

:::note
To obtain the `{access_token}`, make sure to authenticate through one of the methods described [here](https://docs.uipath.com/automation-cloud/automation-cloud/latest/api-guide/authentication-methods#authentication-methods).
:::

## Path Parameters

| Path param | Data type | Description |
| --- | --- | --- |
| `partitionGlobalId` (required) | String (GUID) | The ID of the organization to resolve the entity within. |

## Request Body

The request body specifies the entity to resolve by name.

```json
{
    "entityName": "string",
    "entityType": "User"
}
```

| Property | Data type | Description |
| --- | --- | --- |
| `entityName` (required) | String | The name of the directory entity (e.g., email address for users, group name for groups). |
| `entityType` (required) | String | The type of directory entity. Valid values: `User`, `Group`, `Application`. |

## Responses

### 200 OK

Returns the full directory entity. The response shape is the same as the Resolve endpoint (varies by entity type).

### 404 Not Found

Returned when the entity or partition cannot be found.

## Example Request

Let's say you gathered all the information needed to build the API call.

* Your `{baseURL}` is: https://cloud.uipath.com/{organizationName}/identity_
* Your `{access_token}` is: `1234` (for length considerations).
* The `{partitionGlobalId}` is: `3fa85f64-5717-4562-b3fc-2c963f66afa6`
* You want to resolve a user by their email `john.doe@example.com`.

The call should resemble the following example (cURL):

```
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/ResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityName": "john.doe@example.com",
    "entityType": "User"
}'
```

Here's the response body for a successful call:

```json
{
    "objectType": "DirectoryUser",
    "source": "aad",
    "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "john.doe@example.com",
    "email": "john.doe@example.com",
    "displayName": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "jobTitle": "Software Engineer",
    "companyName": "Contoso",
    "city": "Seattle",
    "department": "Engineering",
    "isActive": true,
    "creationTime": "2025-01-15T10:30:00Z"
}
```