Swift3 / Support API / Create User
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"
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "user": {
// "name": "<string>",
// "email": "<string>",
// "custom_role_id": "<integer>",
// "external_id": "<string>",
// "identities": [
// {
// "type": "<string>",
// "value": "<string>"
// },
// {
// "type": "<string>",
// "value": "<string>"
// }
// ],
// "organization": {
// "name": "<string>"
// },
// "organization_id": "<integer>",
// "role": "<string>"
// }
// }
let json = CkoJsonObject()!
json.update("user.name", value: "<string>")
json.update("user.email", value: "<string>")
json.update("user.custom_role_id", value: "<integer>")
json.update("user.external_id", value: "<string>")
json.update("user.identities[0].type", value: "<string>")
json.update("user.identities[0].value", value: "<string>")
json.update("user.identities[1].type", value: "<string>")
json.update("user.identities[1].value", value: "<string>")
json.update("user.organization.name", value: "<string>")
json.update("user.organization_id", value: "<integer>")
json.update("user.role", value: "<string>")
http.setRequestHeader("Content-Type", value: "application/json")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.postJson3("https://example.zendesk.com/api/v2/users", contentType: "application/json", json: json)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "user": {
// "name": "<string>",
// "active": "<boolean>",
// "alias": "<string>",
// "chat_only": "<boolean>",
// "created_at": "<string>",
// "custom_role_id": "<integer>",
// "default_group_id": "<integer>",
// "details": "<string>",
// "email": "<string>",
// "external_id": "<string>",
// "iana_time_zone": "<string>",
// "id": "<integer>",
// "last_login_at": "<string>",
// "locale": "<string>",
// "locale_id": "<integer>",
// "moderator": "<boolean>",
// "notes": "<string>",
// "only_private_comments": "<boolean>",
// "organization_id": "<integer>",
// "phone": "<string>",
// "photo": {
// "dolorea1": false,
// "deserunt3": 95124319.10825741
// },
// "remote_photo_url": "<string>",
// "report_csv": "<boolean>",
// "restricted_agent": "<boolean>",
// "role": "<string>",
// "role_type": "<integer>",
// "shared": "<boolean>",
// "shared_agent": "<boolean>",
// "shared_phone_number": "<boolean>",
// "signature": "<string>",
// "suspended": "<boolean>",
// "tags": "<array>",
// "ticket_restriction": "<string>",
// "time_zone": "<string>",
// "two_factor_auth_enabled": "<boolean>",
// "updated_at": "<string>",
// "url": "<string>",
// "user_fields": {
// "nostrudacc": -12929960.546221554,
// "in_80e": 25167751.960886702,
// "proident_e2": true,
// "voluptate_98": -58995022
// },
// "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 Name: String? = jResp.string(of: "user.name")
var Active: String? = jResp.string(of: "user.active")
var Alias: String? = jResp.string(of: "user.alias")
var Chat_only: String? = jResp.string(of: "user.chat_only")
var Created_at: String? = jResp.string(of: "user.created_at")
var Custom_role_id: String? = jResp.string(of: "user.custom_role_id")
var Default_group_id: String? = jResp.string(of: "user.default_group_id")
var Details: String? = jResp.string(of: "user.details")
var v_Email: String? = jResp.string(of: "user.email")
var External_id: String? = jResp.string(of: "user.external_id")
var Iana_time_zone: String? = jResp.string(of: "user.iana_time_zone")
var Id: String? = jResp.string(of: "user.id")
var Last_login_at: String? = jResp.string(of: "user.last_login_at")
var Locale: String? = jResp.string(of: "user.locale")
var Locale_id: String? = jResp.string(of: "user.locale_id")
var Moderator: String? = jResp.string(of: "user.moderator")
var Notes: String? = jResp.string(of: "user.notes")
var Only_private_comments: String? = jResp.string(of: "user.only_private_comments")
var Organization_id: String? = jResp.string(of: "user.organization_id")
var Phone: String? = jResp.string(of: "user.phone")
var Dolorea1: Bool = jResp.bool(of: "user.photo.dolorea1")
var Deserunt3: String? = jResp.string(of: "user.photo.deserunt3")
var Remote_photo_url: String? = jResp.string(of: "user.remote_photo_url")
var Report_csv: String? = jResp.string(of: "user.report_csv")
var Restricted_agent: String? = jResp.string(of: "user.restricted_agent")
var Role: String? = jResp.string(of: "user.role")
var Role_type: String? = jResp.string(of: "user.role_type")
var v_Shared: String? = jResp.string(of: "user.shared")
var Shared_agent: String? = jResp.string(of: "user.shared_agent")
var Shared_phone_number: String? = jResp.string(of: "user.shared_phone_number")
var Signature: String? = jResp.string(of: "user.signature")
var Suspended: String? = jResp.string(of: "user.suspended")
var Tags: String? = jResp.string(of: "user.tags")
var Ticket_restriction: String? = jResp.string(of: "user.ticket_restriction")
var Time_zone: String? = jResp.string(of: "user.time_zone")
var Two_factor_auth_enabled: String? = jResp.string(of: "user.two_factor_auth_enabled")
var Updated_at: String? = jResp.string(of: "user.updated_at")
var v_Url: String? = jResp.string(of: "user.url")
var Nostrudacc: String? = jResp.string(of: "user.user_fields.nostrudacc")
var In_80e: String? = jResp.string(of: "user.user_fields.in_80e")
var Proident_e2: Bool = jResp.bool(of: "user.user_fields.proident_e2")
var Voluptate_98: Int = jResp.int(of: "user.user_fields.voluptate_98").intValue
var Verified: String? = jResp.string(of: "user.verified")
}
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"user": {
"name": "<string>",
"email": "<string>",
"custom_role_id": "<integer>",
"external_id": "<string>",
"identities": [
{
"type": "<string>",
"value": "<string>"
},
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"name": "<string>"
},
"organization_id": "<integer>",
"role": "<string>"
}
}'
https://example.zendesk.com/api/v2/users
Postman Collection Item JSON
{
"name": "Create User",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"user\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"external_id\": \"<string>\",\n \"identities\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"organization\": {\n \"name\": \"<string>\"\n },\n \"organization_id\": \"<integer>\",\n \"role\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"response": [
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"user\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"external_id\": \"<string>\",\n \"identities\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"organization\": {\n \"name\": \"<string>\"\n },\n \"organization_id\": \"<integer>\",\n \"role\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"dolorea1\": false,\n \"deserunt3\": 95124319.10825741\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"nostrudacc\": -12929960.546221554,\n \"in_80e\": 25167751.960886702,\n \"proident_e2\": true,\n \"voluptate_98\": -58995022\n },\n \"verified\": \"<boolean>\"\n }\n}"
}
]
}
