unicodeCpp / Support API / List Identities
Back to Collection Items
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(L"password");
http.SetRequestHeader(L"Accept",L"application/json");
CkStringBuilderW sbResponseBody;
success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/users/:user_id/identities",sbResponseBody);
if (success == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = http.get_LastStatus();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",http.lastHeader());
wprintf(L"Failed.\n");
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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const wchar_t *user_id = 0;
const wchar_t *v_type = 0;
const wchar_t *value = 0;
const wchar_t *created_at = 0;
const wchar_t *deliverable_state = 0;
const wchar_t *id = 0;
const wchar_t *primary = 0;
const wchar_t *undeliverable_count = 0;
const wchar_t *updated_at = 0;
const wchar_t *url = 0;
const wchar_t *verified = 0;
int i = 0;
int count_i = jResp.SizeOfArray(L"identities");
while (i < count_i) {
jResp.put_I(i);
user_id = jResp.stringOf(L"identities[i].user_id");
v_type = jResp.stringOf(L"identities[i].type");
value = jResp.stringOf(L"identities[i].value");
created_at = jResp.stringOf(L"identities[i].created_at");
deliverable_state = jResp.stringOf(L"identities[i].deliverable_state");
id = jResp.stringOf(L"identities[i].id");
primary = jResp.stringOf(L"identities[i].primary");
undeliverable_count = jResp.stringOf(L"identities[i].undeliverable_count");
updated_at = jResp.stringOf(L"identities[i].updated_at");
url = jResp.stringOf(L"identities[i].url");
verified = jResp.stringOf(L"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}"
}
]
}
