Get User with Email Address

get

/documents/api/1.1/users/search/items

The service uses an email address as search text provided with the call to match a specific user. The search returns the matching user, if any.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

email

Type: string

Required: true

Specify an email address as a search string used to return a specific matching user. Wildcard characters are not supported.

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

If no user is matched, count and errorCode will be "0" and items will not be returned.

Body

Folder metadata information.

Root Schema : UsersResponse

Folder metadata information.

Properties

count

Type: string

The number of users found.

errorCode

Type: string

An error code of zero (0) indicates no errors.

items

Type: array items

Additional Properties Allowed:

Minimum Number of Items: 0

Nested Schema : items

Type: array

Minimum Number of Items: 0

Items

• Type: object User
  Additional Properties Allowed:
  User information

Nested Schema : User

User information

Properties

displayName

Type: string

The display name for the user.

id

Type: string

Globally unique identifier (GUID) for the user.

type

Type: string

Item type user.

Example application/json

{
    "count":"1",
    "errorCode":"0",
    "items":[
        {
            "id":"U0EAA20910FAF3052ACB79E4T00000000001",
            "displayName":"User AA",
            "loginName":"userAALoginName",
            "type":"user"
        }
    ]
}

400 Response

Required field "email" is not provided.

Examples

The following example returns the user with the specified email address.

GET .../users/search/items?email=[e-mail]

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "1",
    "errorCode": "0",
    "items": [
        {
            "type": "user",
            "id": "Tenant1.UserB",
            "displayName": "Tenant1 UserB",
            "loginName": "userBBLoginName"
        }
    ]
}

Example 2

The following example shows the results of a search for a user by email when no match is found.

GET .../users/search/items?email=[e-mail]

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "0",
    "errorCode": "0"
}

Example 3

The following example shows the results of searching for a user without passing in the email parameter.

GET .../users/search/items?emailtypo=[e-mail]

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 400

JSON Response

{
    "count": "0",
    "errorCode": "-97",
    "errorKey": "!csUnableToRetrieveUserList!csRequiredFieldMissing2,dEmail",
    "errorMessage": "Unable to retrieve user list. The required field 'dEmail' is missing.",
    "title": "Unable to retrieve user list. The required field 'dEmail' is missing.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}