Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateInt("page[size]",10)
$queryParams.UpdateInt("page[number]",0)
$queryParams.UpdateString("sort","saml_assertion_attribute.attribute_value")
$queryParams.UpdateString("filter","<string>")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/authn_mappings",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$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 -lt $count_i) {
$jResp.I = $i
$id = $jResp.StringOf("data[i].id")
$v_type = $jResp.StringOf("data[i].type")
$Attribute_key = $jResp.StringOf("data[i].attributes.attribute_key")
$Attribute_value = $jResp.StringOf("data[i].attributes.attribute_value")
$Created_at = $jResp.StringOf("data[i].attributes.created_at")
$Modified_at = $jResp.StringOf("data[i].attributes.modified_at")
$Saml_assertion_attribute_id = $jResp.StringOf("data[i].attributes.saml_assertion_attribute_id")
$Id = $jResp.StringOf("data[i].relationships.role.data.id")
$v_Type = $jResp.StringOf("data[i].relationships.role.data.type")
$DataId = $jResp.StringOf("data[i].relationships.saml_assertion_attribute.data.id")
$DataType = $jResp.StringOf("data[i].relationships.saml_assertion_attribute.data.type")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("included")
while ($i -lt $count_i) {
$jResp.I = $i
$id = $jResp.StringOf("included[i].id")
$v_type = $jResp.StringOf("included[i].type")
$attributesAttribute_key = $jResp.StringOf("included[i].attributes.attribute_key")
$attributesAttribute_value = $jResp.StringOf("included[i].attributes.attribute_value")
$i = $i + 1
}
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}"
}
]
}
