Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateInt $queryParams "page[size]" 10
CkJsonObject_UpdateInt $queryParams "page[number]" 0
CkJsonObject_UpdateString $queryParams "sort" "saml_assertion_attribute.attribute_value"
CkJsonObject_UpdateString $queryParams "filter" "<string>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v2/authn_mappings" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "id": "<string>",
# "type": "authn_mappings",
# "attributes": {
# "attribute_key": "<string>",
# "attribute_value": "<string>",
# "created_at": "<dateTime>",
# "modified_at": "<dateTime>",
# "saml_assertion_attribute_id": "<string>"
# },
# "relationships": {
# "role": {
# "data": {
# "id": "<string>",
# "type": "roles"
# }
# },
# "saml_assertion_attribute": {
# "data": {
# "id": "<string>",
# "type": "saml_assertion_attributes"
# }
# }
# }
# },
# {
# "id": "<string>",
# "type": "authn_mappings",
# "attributes": {
# "attribute_key": "<string>",
# "attribute_value": "<string>",
# "created_at": "<dateTime>",
# "modified_at": "<dateTime>",
# "saml_assertion_attribute_id": "<string>"
# },
# "relationships": {
# "role": {
# "data": {
# "id": "<string>",
# "type": "roles"
# }
# },
# "saml_assertion_attribute": {
# "data": {
# "id": "<string>",
# "type": "saml_assertion_attributes"
# }
# }
# }
# }
# ],
# "included": [
# {
# "id": "<string>",
# "type": "saml_assertion_attributes",
# "attributes": {
# "attribute_key": "<string>",
# "attribute_value": "<string>"
# }
# },
# {
# "id": "<string>",
# "type": "saml_assertion_attributes",
# "attributes": {
# "attribute_key": "<string>",
# "attribute_value": "<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
set Total_count [CkJsonObject_stringOf $jResp "meta.page.total_count"]
set Total_filtered_count [CkJsonObject_stringOf $jResp "meta.page.total_filtered_count"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set Attribute_key [CkJsonObject_stringOf $jResp "data[i].attributes.attribute_key"]
set Attribute_value [CkJsonObject_stringOf $jResp "data[i].attributes.attribute_value"]
set Created_at [CkJsonObject_stringOf $jResp "data[i].attributes.created_at"]
set Modified_at [CkJsonObject_stringOf $jResp "data[i].attributes.modified_at"]
set Saml_assertion_attribute_id [CkJsonObject_stringOf $jResp "data[i].attributes.saml_assertion_attribute_id"]
set Id [CkJsonObject_stringOf $jResp "data[i].relationships.role.data.id"]
set v_Type [CkJsonObject_stringOf $jResp "data[i].relationships.role.data.type"]
set DataId [CkJsonObject_stringOf $jResp "data[i].relationships.saml_assertion_attribute.data.id"]
set DataType [CkJsonObject_stringOf $jResp "data[i].relationships.saml_assertion_attribute.data.type"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "included"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "included[i].id"]
set v_type [CkJsonObject_stringOf $jResp "included[i].type"]
set attributesAttribute_key [CkJsonObject_stringOf $jResp "included[i].attributes.attribute_key"]
set attributesAttribute_value [CkJsonObject_stringOf $jResp "included[i].attributes.attribute_value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-d "sort=saml_assertion_attribute.attribute_value"
-d "filter=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/authn_mappings
Postman Collection Item JSON
{
"name": "List all AuthN Mappings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings?page[size]=10&page[number]=0&sort=saml_assertion_attribute.attribute_value&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"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": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all mappings by the given string."
}
]
},
"description": "List all AuthN Mappings in the org."
},
"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/authn_mappings?page[size]=10&page[number]=0&sort=saml_assertion_attribute.attribute_value&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"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": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all mappings by the given string."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"saml_assertion_attribute_id\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n },\n \"saml_assertion_attribute\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"saml_assertion_attributes\"\n }\n }\n }\n },\n {\n \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"saml_assertion_attribute_id\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n },\n \"saml_assertion_attribute\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"saml_assertion_attributes\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"<string>\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n },\n {\n \"id\": \"<string>\",\n \"type\": \"saml_assertion_attributes\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": \"<long>\",\n \"total_filtered_count\": \"<long>\"\n }\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/authn_mappings?page[size]=10&page[number]=0&sort=saml_assertion_attribute.attribute_value&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"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": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all mappings by the given string."
}
]
}
},
"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/authn_mappings?page[size]=10&page[number]=0&sort=saml_assertion_attribute.attribute_value&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings"
],
"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": "saml_assertion_attribute.attribute_value",
"description": "Sort AuthN Mappings depending on the given field."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all mappings by the given string."
}
]
}
},
"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}"
}
]
}
