Chilkat Online Tools

Ruby / Support API / Verify Identity

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

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

# resp is a CkHttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/users/:user_id/identities/:user_identity_id/verify")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

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

Curl Command

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

Postman Collection Item JSON

{
  "name": "Verify Identity",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/verify",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "identities",
        ":user_identity_id",
        "verify"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        },
        {
          "key": "user_identity_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Sets the specified identity as verified.\n\n#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "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/verify",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "identities",
            ":user_identity_id",
            "verify"
          ],
          "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}"
    }
  ]
}