Chilkat Online Tools

VB.NET / 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.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader("Accept","application/json")

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/users/:user_id/identities",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim user_id As String
Dim v_type As String
Dim value As String
Dim created_at As String
Dim deliverable_state As String
Dim id As String
Dim primary As String
Dim undeliverable_count As String
Dim updated_at As String
Dim url As String
Dim verified As String

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("identities")
While i < count_i
    jResp.I = i
    user_id = jResp.StringOf("identities[i].user_id")
    v_type = jResp.StringOf("identities[i].type")
    value = jResp.StringOf("identities[i].value")
    created_at = jResp.StringOf("identities[i].created_at")
    deliverable_state = jResp.StringOf("identities[i].deliverable_state")
    id = jResp.StringOf("identities[i].id")
    primary = jResp.StringOf("identities[i].primary")
    undeliverable_count = jResp.StringOf("identities[i].undeliverable_count")
    updated_at = jResp.StringOf("identities[i].updated_at")
    url = jResp.StringOf("identities[i].url")
    verified = jResp.StringOf("identities[i].verified")
    i = i + 1
End While

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}"
    }
  ]
}