Search users by GUID

5 min

This call searches for users by GUID. See User. This call returns custom LDAP attributes along with other user information, unless issued with the fields="ldapStandardAttributes" parameter, which adds LDAP standard attributes to the response.

HTTP Method

GET

Request URI

/msa/v1/cps/user?guid=<string>&fields="ldapStandardAttributes"

Request parameters

Parameter	Description	Sample Value
guid	Parameter Type: Query Data Type: String	dd8b7006-2780-49c1-9b03-f85aa57c9da4
fields="ldapStandardAttributes"	Optional Parameter Type: Query Data Type: String If this parameter is included, the return includes the following standard LDAP attributes: distinguishedName samAccountName userPrincipalName	fields="ldapStandardAttributes"

Response fields

A list of users.

See List of identifiers and User.

Example responses

Local accountSource

{
  "searchResults": [
    {
      "enabled": true,
      "createdAt": 1580812767902,
      "accountSource": "LOCAL",
      "displayName": "John Doe",
      "emailAddress": "[email protected]",
      "firstName": "John",
      "lastName": "Doe",
      "userId": "[email protected]",
      "userUuid": "dd8b7006-2780-49c1-9b03-f85aa57c9da4",
      "guid": "dd8b7006-2780-49c1-9b03-f85aa57c9da4"
    }
  ],
  "results": 1,
  "offset": 0,
  "limit": 50
}

LDAP accountSource with fields="ldapStandardAttributes" parameter included in the call

{
  "limit": 50,
  "offset": 0,
  "results": 1,
  "searchResults": [
    {
      "accountSource": "LDAP",
      "createdAt": 1500444347689,
      "displayName": "Fred A",
      "emailAddress": "[email protected]",
      "enabled": true,
      "firstName": "Fred",
      "ldapCustomAttributes": {
        "lastlogontimestamp": "131516814255658414",
        "mailnickname": "Fred",
        "mdbusedefaults": "TRUE",
        "msexchmailboxguid": "k\ufffd\ufffdVt\ufffdN\ufffd\ufffdS)\u289e=",
        "msexchrecipientdisplaytype": "1073741824",
        "msexchwhenmailboxcreated": "20140407185418.0Z"
      },
      "ldapStandardAttributes": {
        "distinguishedName": "foo",
        "samAccountName": "bar",
        "userPrincipalName": "baz"
      }
      "userId": "[email protected]",
      "userUuid": "a3343fd0-c1f2-424f-a993-83b951c94246",
      "guid": "dd8b7006-2780-49c1-9b03-f85aa57c9da4"
    }
  ]
}