Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_V_type
string ls_AttributesAttribute_key
string ls_AttributesAttribute_value
string ls_Id
string ls_V_Type
string ls_Attribute_key
string ls_Attribute_value
string ls_Created_at
string ls_Modified_at
string ls_Saml_assertion_attribute_id
string ls_DataId
string ls_DataType
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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": {
// "id": "<string>",
// "type": "authn_mappings",
// "attributes": {
// "attribute_key": "<string>",
// "attribute_value": "<string>"
// },
// "relationships": {
// "role": {
// "data": {
// "id": "<string>",
// "type": "roles"
// }
// }
// }
// }
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("data.id","<string>")
loo_Json.UpdateString("data.type","authn_mappings")
loo_Json.UpdateString("data.attributes.attribute_key","<string>")
loo_Json.UpdateString("data.attributes.attribute_value","<string>")
loo_Json.UpdateString("data.relationships.role.data.id","<string>")
loo_Json.UpdateString("data.relationships.role.data.type","roles")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Json.EmitSb(loo_SbRequestBody)
loo_Resp = loo_Http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/authn_mappings/:authn_mapping_id",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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"
// }
// }
// }
// },
// "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>"
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Id = loo_JResp.StringOf("data.id")
ls_V_Type = loo_JResp.StringOf("data.type")
ls_Attribute_key = loo_JResp.StringOf("data.attributes.attribute_key")
ls_Attribute_value = loo_JResp.StringOf("data.attributes.attribute_value")
ls_Created_at = loo_JResp.StringOf("data.attributes.created_at")
ls_Modified_at = loo_JResp.StringOf("data.attributes.modified_at")
ls_Saml_assertion_attribute_id = loo_JResp.StringOf("data.attributes.saml_assertion_attribute_id")
ls_DataId = loo_JResp.StringOf("data.relationships.role.data.id")
ls_DataType = loo_JResp.StringOf("data.relationships.role.data.type")
ls_DataId = loo_JResp.StringOf("data.relationships.saml_assertion_attribute.data.id")
ls_DataType = loo_JResp.StringOf("data.relationships.saml_assertion_attribute.data.type")
i = 0
li_Count_i = loo_JResp.SizeOfArray("included")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("included[i].id")
ls_V_type = loo_JResp.StringOf("included[i].type")
ls_AttributesAttribute_key = loo_JResp.StringOf("included[i].attributes.attribute_key")
ls_AttributesAttribute_value = loo_JResp.StringOf("included[i].attributes.attribute_value")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "authn_mappings",
"attributes": {
"attribute_key": "<string>",
"attribute_value": "<string>"
},
"relationships": {
"role": {
"data": {
"id": "<string>",
"type": "roles"
}
}
}
}
}'
https://api.app.ddog-gov.com/api/v2/authn_mappings/:authn_mapping_id
Postman Collection Item JSON
{
"name": "Edit an AuthN Mapping",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id",
"value": "<string>"
}
]
},
"description": "Edit an AuthN Mapping."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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 \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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 \"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}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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 \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"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": "PATCH",
"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 \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"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": "Not Found",
"originalRequest": {
"method": "PATCH",
"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 \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PATCH",
"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 \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"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 \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_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": "PATCH",
"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 \"id\": \"<string>\",\n \"type\": \"authn_mappings\",\n \"attributes\": {\n \"attribute_key\": \"<string>\",\n \"attribute_value\": \"<string>\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/authn_mappings/:authn_mapping_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"authn_mappings",
":authn_mapping_id"
],
"variable": [
{
"key": "authn_mapping_id"
}
]
}
},
"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}"
}
]
}
