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()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "data": {
# "attributes": {
# "email": "<string>",
# "name": "<string>",
# "title": "<string>"
# },
# "type": "users",
# "relationships": {
# "roles": {
# "data": [
# {
# "id": "<string>",
# "type": "roles"
# },
# {
# "id": "<string>",
# "type": "roles"
# }
# ]
# }
# }
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("data.attributes.email","<string>")
json.UpdateString("data.attributes.name","<string>")
json.UpdateString("data.attributes.title","<string>")
json.UpdateString("data.type","users")
json.UpdateString("data.relationships.roles.data[0].id","<string>")
json.UpdateString("data.relationships.roles.data[0].type","roles")
json.UpdateString("data.relationships.roles.data[1].id","<string>")
json.UpdateString("data.relationships.roles.data[1].type","roles")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/users","application/json",json)
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)
# {
# "data": {
# "attributes": {
# "created_at": "<dateTime>",
# "disabled": "<boolean>",
# "email": "<string>",
# "handle": "<string>",
# "icon": "<string>",
# "modified_at": "<dateTime>",
# "name": "<string>",
# "service_account": "<boolean>",
# "status": "<string>",
# "title": "<string>",
# "verified": "<boolean>"
# },
# "id": "<string>",
# "relationships": {
# "org": {
# "data": {
# "id": "<string>",
# "type": "orgs"
# }
# },
# "other_orgs": {
# "data": [
# {
# "id": "<string>",
# "type": "orgs"
# },
# {
# "id": "<string>",
# "type": "orgs"
# }
# ]
# },
# "other_users": {
# "data": [
# {
# "id": "<string>",
# "type": "users"
# },
# {
# "id": "<string>",
# "type": "users"
# }
# ]
# },
# "roles": {
# "data": [
# {
# "id": "<string>",
# "type": "roles"
# },
# {
# "id": "<string>",
# "type": "roles"
# }
# ]
# }
# },
# "type": "users"
# },
# "included": [
# {
# "type": "orgs",
# "attributes": {
# "created_at": "<dateTime>",
# "description": "<string>",
# "disabled": "<boolean>",
# "modified_at": "<dateTime>",
# "name": "<string>",
# "public_id": "<string>",
# "sharing": "<string>",
# "url": "<string>"
# },
# "id": "<string>"
# },
# {
# "type": "orgs",
# "attributes": {
# "created_at": "<dateTime>",
# "description": "<string>",
# "disabled": "<boolean>",
# "modified_at": "<dateTime>",
# "name": "<string>",
# "public_id": "<string>",
# "sharing": "<string>",
# "url": "<string>"
# },
# "id": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Created_at = jResp.stringOf("data.attributes.created_at")
Disabled = jResp.stringOf("data.attributes.disabled")
v_Email = jResp.stringOf("data.attributes.email")
Handle = jResp.stringOf("data.attributes.handle")
Icon = jResp.stringOf("data.attributes.icon")
Modified_at = jResp.stringOf("data.attributes.modified_at")
Name = jResp.stringOf("data.attributes.name")
Service_account = jResp.stringOf("data.attributes.service_account")
Status = jResp.stringOf("data.attributes.status")
Title = jResp.stringOf("data.attributes.title")
Verified = jResp.stringOf("data.attributes.verified")
Id = jResp.stringOf("data.id")
DataId = jResp.stringOf("data.relationships.org.data.id")
v_Type = jResp.stringOf("data.relationships.org.data.type")
dataType = jResp.stringOf("data.type")
i = 0
count_i = jResp.SizeOfArray("data.relationships.other_orgs.data")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("data.relationships.other_orgs.data[i].id")
v_type = jResp.stringOf("data.relationships.other_orgs.data[i].type")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("data.relationships.other_users.data")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("data.relationships.other_users.data[i].id")
v_type = jResp.stringOf("data.relationships.other_users.data[i].type")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("data.relationships.roles.data")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("data.relationships.roles.data[i].id")
v_type = jResp.stringOf("data.relationships.roles.data[i].type")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("included")
while i < count_i
jResp.put_I(i)
v_type = jResp.stringOf("included[i].type")
attributesCreated_at = jResp.stringOf("included[i].attributes.created_at")
Description = jResp.stringOf("included[i].attributes.description")
attributesDisabled = jResp.stringOf("included[i].attributes.disabled")
attributesModified_at = jResp.stringOf("included[i].attributes.modified_at")
attributesName = jResp.stringOf("included[i].attributes.name")
Public_id = jResp.stringOf("included[i].attributes.public_id")
Sharing = jResp.stringOf("included[i].attributes.sharing")
v_Url = jResp.stringOf("included[i].attributes.url")
id = jResp.stringOf("included[i].id")
i = i + 1
end
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"email": "<string>",
"name": "<string>",
"title": "<string>"
},
"type": "users",
"relationships": {
"roles": {
"data": [
{
"id": "<string>",
"type": "roles"
},
{
"id": "<string>",
"type": "roles"
}
]
}
}
}
}'
https://api.app.ddog-gov.com/api/v2/users
Postman Collection Item JSON
{
"name": "Create a user",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
},
"description": "Create a user for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n }\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 \"data\": {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"type\": \"users\",\n \"relationships\": {\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
