VBScript / Support API / List Identities
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
http.SetRequestHeader "Accept","application/json"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = http.QuickGetSb("https://example.zendesk.com/api/v2/users/:user_id/identities",sbResponseBody)
If (success = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())
respStatusCode = http.LastStatus
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
outFile.WriteLine("Response Header:")
outFile.WriteLine(http.LastHeader)
outFile.WriteLine("Failed.")
WScript.Quit
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
i = 0
count_i = jResp.SizeOfArray("identities")
Do 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
Loop
outFile.Close
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}"
}
]
}
