Chilkat Online Tools

PowerBuilder / Support API / List Identities

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_User_id
string ls_V_type
string ls_Value
string ls_Created_at
string ls_Deliverable_state
string ls_Id
string ls_Primary
string ls_Undeliverable_count
string ls_Updated_at
string ls_Url
string ls_Verified
integer i
integer li_Count_i

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"

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

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://example.zendesk.com/api/v2/users/:user_id/identities",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
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
li_Count_i = loo_JResp.SizeOfArray("identities")
do while i < li_Count_i
    loo_JResp.I = i
    ls_User_id = loo_JResp.StringOf("identities[i].user_id")
    ls_V_type = loo_JResp.StringOf("identities[i].type")
    ls_Value = loo_JResp.StringOf("identities[i].value")
    ls_Created_at = loo_JResp.StringOf("identities[i].created_at")
    ls_Deliverable_state = loo_JResp.StringOf("identities[i].deliverable_state")
    ls_Id = loo_JResp.StringOf("identities[i].id")
    ls_Primary = loo_JResp.StringOf("identities[i].primary")
    ls_Undeliverable_count = loo_JResp.StringOf("identities[i].undeliverable_count")
    ls_Updated_at = loo_JResp.StringOf("identities[i].updated_at")
    ls_Url = loo_JResp.StringOf("identities[i].url")
    ls_Verified = loo_JResp.StringOf("identities[i].verified")
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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