Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sV_type
String sAttribute_key
String sAttribute_value
String sCreated_at
String sModified_at
String sSaml_assertion_attribute_id
String sId
String sV_Type
String sDataId
String sDataType
String sAttributesAttribute_key
String sAttributesAttribute_value
String sTotal_count
String sTotal_filtered_count
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateInt Of hoQueryParams "page[size]" 10 To iSuccess
Get ComUpdateInt Of hoQueryParams "page[number]" 0 To iSuccess
Get ComUpdateString Of hoQueryParams "sort" "saml_assertion_attribute.attribute_value" To iSuccess
Get ComUpdateString Of hoQueryParams "filter" "<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.app.ddog-gov.com/api/v2/authn_mappings" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "meta.page.total_count" To sTotal_count
Get ComStringOf Of hoJResp "meta.page.total_filtered_count" To sTotal_filtered_count
Move 0 To i
Get ComSizeOfArray Of hoJResp "data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data[i].id" To sId
Get ComStringOf Of hoJResp "data[i].type" To sV_type
Get ComStringOf Of hoJResp "data[i].attributes.attribute_key" To sAttribute_key
Get ComStringOf Of hoJResp "data[i].attributes.attribute_value" To sAttribute_value
Get ComStringOf Of hoJResp "data[i].attributes.created_at" To sCreated_at
Get ComStringOf Of hoJResp "data[i].attributes.modified_at" To sModified_at
Get ComStringOf Of hoJResp "data[i].attributes.saml_assertion_attribute_id" To sSaml_assertion_attribute_id
Get ComStringOf Of hoJResp "data[i].relationships.role.data.id" To sId
Get ComStringOf Of hoJResp "data[i].relationships.role.data.type" To sV_Type
Get ComStringOf Of hoJResp "data[i].relationships.saml_assertion_attribute.data.id" To sDataId
Get ComStringOf Of hoJResp "data[i].relationships.saml_assertion_attribute.data.type" To sDataType
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "included" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "included[i].id" To sId
Get ComStringOf Of hoJResp "included[i].type" To sV_type
Get ComStringOf Of hoJResp "included[i].attributes.attribute_key" To sAttributesAttribute_key
Get ComStringOf Of hoJResp "included[i].attributes.attribute_value" To sAttributesAttribute_value
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
