Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.Http()
queryParams = chilkat2.JsonObject()
queryParams.UpdateInt("page[size]",10)
queryParams.UpdateInt("page[number]",0)
queryParams.UpdateString("sort","name")
queryParams.UpdateString("sort_dir","desc")
queryParams.UpdateString("filter","<string>")
queryParams.UpdateString("filter[status]","<string>")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/users",queryParams)
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# 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"
# },
# {
# "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>"
# }
# ],
# "meta": {
# "page": {
# "total_count": "<long>",
# "total_filtered_count": "<long>"
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Total_count = jResp.StringOf("meta.page.total_count")
Total_filtered_count = jResp.StringOf("meta.page.total_filtered_count")
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i :
jResp.I = i
Created_at = jResp.StringOf("data[i].attributes.created_at")
Disabled = jResp.StringOf("data[i].attributes.disabled")
v_Email = jResp.StringOf("data[i].attributes.email")
Handle = jResp.StringOf("data[i].attributes.handle")
Icon = jResp.StringOf("data[i].attributes.icon")
Modified_at = jResp.StringOf("data[i].attributes.modified_at")
Name = jResp.StringOf("data[i].attributes.name")
Service_account = jResp.StringOf("data[i].attributes.service_account")
Status = jResp.StringOf("data[i].attributes.status")
Title = jResp.StringOf("data[i].attributes.title")
Verified = jResp.StringOf("data[i].attributes.verified")
id = jResp.StringOf("data[i].id")
Id = jResp.StringOf("data[i].relationships.org.data.id")
v_Type = jResp.StringOf("data[i].relationships.org.data.type")
v_type = jResp.StringOf("data[i].type")
j = 0
count_j = jResp.SizeOfArray("data[i].relationships.other_orgs.data")
while j < count_j :
jResp.J = j
id = jResp.StringOf("data[i].relationships.other_orgs.data[j].id")
v_type = jResp.StringOf("data[i].relationships.other_orgs.data[j].type")
j = j + 1
j = 0
count_j = jResp.SizeOfArray("data[i].relationships.other_users.data")
while j < count_j :
jResp.J = j
id = jResp.StringOf("data[i].relationships.other_users.data[j].id")
v_type = jResp.StringOf("data[i].relationships.other_users.data[j].type")
j = j + 1
j = 0
count_j = jResp.SizeOfArray("data[i].relationships.roles.data")
while j < count_j :
jResp.J = j
id = jResp.StringOf("data[i].relationships.roles.data[j].id")
v_type = jResp.StringOf("data[i].relationships.roles.data[j].type")
j = j + 1
i = i + 1
i = 0
count_i = jResp.SizeOfArray("included")
while i < count_i :
jResp.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
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-d "sort=name"
-d "sort_dir=desc"
-d "filter=%3Cstring%3E"
-d "filter[status]=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/users
Postman Collection Item JSON
{
"name": "List all users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users?page[size]=10&page[number]=0&sort=name&sort_dir=desc&filter=<string>&filter[status]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
},
{
"key": "filter[status]",
"value": "<string>",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering."
}
]
},
"description": "Get the list of all users in the organization. This list includes\nall users even if they are deactivated or unverified."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users?page[size]=10&page[number]=0&sort=name&sort_dir=desc&filter=<string>&filter[status]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
},
{
"key": "filter[status]",
"value": "<string>",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\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 {\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 ],\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 \"meta\": {\n \"page\": {\n \"total_count\": \"<long>\",\n \"total_filtered_count\": \"<long>\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users?page[size]=10&page[number]=0&sort=name&sort_dir=desc&filter=<string>&filter[status]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
},
{
"key": "filter[status]",
"value": "<string>",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering."
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users?page[size]=10&page[number]=0&sort=name&sort_dir=desc&filter=<string>&filter[status]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
},
{
"key": "filter[status]",
"value": "<string>",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering."
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users?page[size]=10&page[number]=0&sort=name&sort_dir=desc&filter=<string>&filter[status]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is ascending by default.\nSort order is descending if the field\nis prefixed by a negative sign, for example `sort=-name`. Options: `name`,\n`modified_at`, `user_count`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Direction of sort. Options: `asc`, `desc`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
},
{
"key": "filter[status]",
"value": "<string>",
"description": "Filter on status attribute.\nComma separated list, with possible values `Active`, `Pending`, and `Disabled`.\nDefaults to no filtering."
}
]
}
},
"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}"
}
]
}
