Chilkat Online Tools

Foxpro / Datadog API Collection / Create an AuthN Mapping

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_type
LOCAL lcAttributesAttribute_key
LOCAL lcAttributesAttribute_value
LOCAL lcId
LOCAL lcV_Type
LOCAL lcAttribute_key
LOCAL lcAttribute_value
LOCAL lcCreated_at
LOCAL lcModified_at
LOCAL lcSaml_assertion_attribute_id
LOCAL lcDataId
LOCAL lcDataType
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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": {
*     "type": "authn_mappings",
*     "attributes": {
*       "attribute_key": "<string>",
*       "attribute_value": "<string>"
*     },
*     "relationships": {
*       "role": {
*         "data": {
*           "id": "<string>",
*           "type": "roles"
*         }
*       }
*     }
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("data.type","authn_mappings")
loJson.UpdateString("data.attributes.attribute_key","<string>")
loJson.UpdateString("data.attributes.attribute_value","<string>")
loJson.UpdateString("data.relationships.role.data.id","<string>")
loJson.UpdateString("data.relationships.role.data.type","roles")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v2/authn_mappings","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcId = loJResp.StringOf("data.id")
lcV_Type = loJResp.StringOf("data.type")
lcAttribute_key = loJResp.StringOf("data.attributes.attribute_key")
lcAttribute_value = loJResp.StringOf("data.attributes.attribute_value")
lcCreated_at = loJResp.StringOf("data.attributes.created_at")
lcModified_at = loJResp.StringOf("data.attributes.modified_at")
lcSaml_assertion_attribute_id = loJResp.StringOf("data.attributes.saml_assertion_attribute_id")
lcDataId = loJResp.StringOf("data.relationships.role.data.id")
lcDataType = loJResp.StringOf("data.relationships.role.data.type")
lcDataId = loJResp.StringOf("data.relationships.saml_assertion_attribute.data.id")
lcDataType = loJResp.StringOf("data.relationships.saml_assertion_attribute.data.type")
i = 0
lnCount_i = loJResp.SizeOfArray("included")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("included[i].id")
    lcV_type = loJResp.StringOf("included[i].type")
    lcAttributesAttribute_key = loJResp.StringOf("included[i].attributes.attribute_key")
    lcAttributesAttribute_value = loJResp.StringOf("included[i].attributes.attribute_value")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "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

Postman Collection Item JSON

{
  "name": "Create an AuthN Mapping",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\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",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "authn_mappings"
      ]
    },
    "description": "Create an AuthN Mapping."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "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    \"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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "authn_mappings"
          ]
        }
      },
      "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": "POST",
        "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    \"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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "authn_mappings"
          ]
        }
      },
      "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": "POST",
        "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    \"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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "authn_mappings"
          ]
        }
      },
      "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": "POST",
        "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    \"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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "authn_mappings"
          ]
        }
      },
      "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": "Too many requests",
      "originalRequest": {
        "method": "POST",
        "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    \"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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "authn_mappings"
          ]
        }
      },
      "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}"
    }
  ]
}