SQL Server / Support API / Create Identity
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://example.zendesk.com/api/v2/users/:user_id/identities'
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @User_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @User_id OUT, 'identity.user_id'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'identity.type'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'identity.value'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'identity.created_at'
DECLARE @Deliverable_state nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Deliverable_state OUT, 'identity.deliverable_state'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'identity.id'
DECLARE @Primary nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Primary OUT, 'identity.primary'
DECLARE @Undeliverable_count nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Undeliverable_count OUT, 'identity.undeliverable_count'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'identity.updated_at'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'identity.url'
DECLARE @Verified nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Verified OUT, 'identity.verified'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/identities
Postman Collection Item JSON
{
"name": "Create Identity",
"request": {
"method": "POST",
"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": "Adds an identity to a user's profile. An agent can add an identity to any user profile.\n\nSupported identity types:\n\n| Type | Example |\n| ---------------- | ------- |\n| email | `{ \"type\" : \"email\", \"value\" : \"someone@example.com\" }` |\n| twitter | `{ \"type\" : \"twitter\", \"value\" : \"screen_name\" }` |\n| facebook | `{ \"type\" : \"facebook\", \"value\" : \"855769377321\" }` |\n| google | `{ \"type\" : \"google\", \"value\" : \"example@gmail.com\" }` |\n| agent_forwarding | `{ \"type\" : \"agent_forwarding\", \"value\" : \"+1 555-123-4567\" }` |\n| phone_number | `{ \"type\" : \"phone_number\", \"value\" : \"+1 555-123-4567\" }` |\n\nTo create an identity without sending out a verification email, include a `\"skip_verify_email\": true` property.\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"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": "Created",
"code": 201,
"_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}"
}
]
}
