Jump to

• Request
• Response
• Examples

Get Users

get

/documents/api/1.2/users/items

Get information about one or more users for folder and file sharing purposes.

The service uses search text provided with the call to match possible users. The search uses a "fuzzy" search of user names and email addresses to return matching users with the most likely matches listed first.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• info: string

  (Required) Specify a search string used to return matching users. Note that wildcard characters are not supported and an empty parameter value is treated as a missing parameter.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

If no users are matched, count and errorCode will be "0" and items will not be returned.

Body ()

Root Schema : UsersResponse

Type: object

Folder metadata information.

Show Source

• count(optional): string
  The number of users found.
• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• items(optional): array items
  Minimum Number of Items: 0

{
    "description":"Folder metadata information.",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of users found."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/User"
            },
            "minItems":0
        }
    }
}

Nested Schema : items

Type: array

Minimum Number of Items: 0

Show Source

• Array of: object User
  User information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/User"
    },
    "minItems":0
}

Nested Schema : User

Type: object

User information

Show Source

• displayName(optional): string
  The display name for the user.
• id(optional): string
  Globally unique identifier (GUID) for the user.
• loginName(optional): string
  The login name for the user.
• type(optional): string
  Item type user.

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

Example Response (application/json)

{
    "count":"3",
    "errorCode":"0",
    "items":[
        {
            "id":"U0EAA20910FAF3052ACB79E4T00000000001",
            "displayName":"User AA",
            "loginName":"userAALoginName",
            "type":"user"
        },
        {
            "id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
            "displayName":"User BB",
            "loginName":"userBBLoginName",
            "type":"user"
        },
        {
            "id":"UEB4B3EFA6C02D1B46A121B4T00000000001",
            "displayName":"User CC",
            "loginName":"userCCLoginName",
            "type":"user"
        }
    ]
}

400 Response

Required field "info" is not provided.

Back to Top

Examples

The following example returns user information for users whose names contain the specified string.

GET .../users/items?info=user%20A

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "3",
    "errorCode": "0",
    "items": [
        {
            "type": "user",
            "id": "U0EAA20910FAF3052ACB79E4T00000000001",
            "displayName": "User AA",
            "loginName": "userAALoginName"
        },
        {
            "type": "user",
            "id": "U7ECC74059E0FEDFEC66BF5AT00000000001",
            "displayName": "User BB",
            "loginName": "userBBLoginName"
        },
        {
            "type": "user",
            "id": "UEB4B3EFA6C02D1B46A121B4T00000000001",
            "displayName": "User CC",
            "loginName": "userCCLoginName"
        }
    ]
}

Back to Top