Chilkat Online Tools

Java / Support API / List Identities

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

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

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/users/:user_id/identities",sbResponseBody);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = http.get_LastStatus();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(http.lastHeader());
        System.out.println("Failed.");
        return;
        }

    // 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

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

    int i = 0;
    int count_i = jResp.SizeOfArray("identities");
    while (i < count_i) {
        jResp.put_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;
        }
  }
}

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