Chilkat Online Tools

Swift / Support API / Show Identity

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

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

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "identity": {
    //     "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

    var User_id: String? = jResp.StringOf("identity.user_id")
    var v_Type: String? = jResp.StringOf("identity.type")
    var Value: String? = jResp.StringOf("identity.value")
    var Created_at: String? = jResp.StringOf("identity.created_at")
    var Deliverable_state: String? = jResp.StringOf("identity.deliverable_state")
    var Id: String? = jResp.StringOf("identity.id")
    var Primary: String? = jResp.StringOf("identity.primary")
    var Undeliverable_count: String? = jResp.StringOf("identity.undeliverable_count")
    var Updated_at: String? = jResp.StringOf("identity.updated_at")
    var v_Url: String? = jResp.StringOf("identity.url")
    var Verified: String? = jResp.StringOf("identity.verified")

}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id

Postman Collection Item JSON

{
  "name": "Show Identity",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "identities",
        ":user_identity_id"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        },
        {
          "key": "user_identity_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Shows the identity with the given id for a 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 view email or phone number identity.\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/:user_identity_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "identities",
            ":user_identity_id"
          ],
          "variable": [
            {
              "key": "user_id"
            },
            {
              "key": "user_identity_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"identity\": {\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}"
    }
  ]
}