Chilkat Online Tools

autoit / Support API / List Identities

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/users/:user_id/identities",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "identities": [
;     {
;       "user_id": "<integer>",
;       "type": "phone_number",
;       "value": "<string>",
;       "created_at": "<dateTime>",
;       "deliverable_state": "<string>",
;       "id": "<integer>",
;       "primary": "<boolean>",
;       "undeliverable_count": "<integer>",
;       "updated_at": "<dateTime>",
;       "url": "<string>",
;       "verified": "<boolean>"
;     },
;     {
;       "user_id": "<integer>",
;       "type": "google",
;       "value": "<string>",
;       "created_at": "<dateTime>",
;       "deliverable_state": "<string>",
;       "id": "<integer>",
;       "primary": "<boolean>",
;       "undeliverable_count": "<integer>",
;       "updated_at": "<dateTime>",
;       "url": "<string>",
;       "verified": "<boolean>"
;     }
;   ]
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sUser_id
Local $sV_type
Local $sValue
Local $sCreated_at
Local $sDeliverable_state
Local $sId
Local $sPrimary
Local $sUndeliverable_count
Local $sUpdated_at
Local $sUrl
Local $sVerified

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("identities")
While $i < $iCount_i
    $oJResp.I = $i
    $sUser_id = $oJResp.StringOf("identities[i].user_id")
    $sV_type = $oJResp.StringOf("identities[i].type")
    $sValue = $oJResp.StringOf("identities[i].value")
    $sCreated_at = $oJResp.StringOf("identities[i].created_at")
    $sDeliverable_state = $oJResp.StringOf("identities[i].deliverable_state")
    $sId = $oJResp.StringOf("identities[i].id")
    $sPrimary = $oJResp.StringOf("identities[i].primary")
    $sUndeliverable_count = $oJResp.StringOf("identities[i].undeliverable_count")
    $sUpdated_at = $oJResp.StringOf("identities[i].updated_at")
    $sUrl = $oJResp.StringOf("identities[i].url")
    $sVerified = $oJResp.StringOf("identities[i].verified")
    $i = $i + 1
Wend

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/identities

Postman Collection Item JSON

{
  "name": "List Identities",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id/identities",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "identities"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns a list of identities for the given user.\n\nUse the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only list email and phone number identities.\n\n#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Agents\n* Verified end users\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id/identities",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "identities"
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"identities\": [\n    {\n      \"user_id\": \"<integer>\",\n      \"type\": \"phone_number\",\n      \"value\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"deliverable_state\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"primary\": \"<boolean>\",\n      \"undeliverable_count\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"verified\": \"<boolean>\"\n    },\n    {\n      \"user_id\": \"<integer>\",\n      \"type\": \"google\",\n      \"value\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"deliverable_state\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"primary\": \"<boolean>\",\n      \"undeliverable_count\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"verified\": \"<boolean>\"\n    }\n  ]\n}"
    }
  ]
}