Chilkat Online Tools

DataFlex / Datadog API Collection / Get an AuthN Mapping by UUID

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sV_type
    String sAttributesAttribute_key
    String sAttributesAttribute_value
    String sId
    String sV_Type
    String sAttribute_key
    String sAttribute_value
    String sCreated_at
    String sModified_at
    String sSaml_assertion_attribute_id
    String sDataId
    String sDataType
    Integer i
    Integer iCount_i
    String sTemp1

    // 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

    Send ComSetRequestHeader To hoHttp "Accept" "application/json"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api.app.ddog-gov.com/api/v2/authn_mappings/:authn_mapping_id" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    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 ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    // 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

    Get ComStringOf Of hoJResp "data.id" To sId
    Get ComStringOf Of hoJResp "data.type" To sV_Type
    Get ComStringOf Of hoJResp "data.attributes.attribute_key" To sAttribute_key
    Get ComStringOf Of hoJResp "data.attributes.attribute_value" To sAttribute_value
    Get ComStringOf Of hoJResp "data.attributes.created_at" To sCreated_at
    Get ComStringOf Of hoJResp "data.attributes.modified_at" To sModified_at
    Get ComStringOf Of hoJResp "data.attributes.saml_assertion_attribute_id" To sSaml_assertion_attribute_id
    Get ComStringOf Of hoJResp "data.relationships.role.data.id" To sDataId
    Get ComStringOf Of hoJResp "data.relationships.role.data.type" To sDataType
    Get ComStringOf Of hoJResp "data.relationships.saml_assertion_attribute.data.id" To sDataId
    Get ComStringOf Of hoJResp "data.relationships.saml_assertion_attribute.data.type" To sDataType
    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 -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/authn_mappings/:authn_mapping_id

Postman Collection Item JSON

{
  "name": "Get an AuthN Mapping by UUID",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/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": "Get an AuthN Mapping specified by the AuthN Mapping UUID."
  },
  "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/: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": "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/: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": "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/: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": "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/: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}"
    }
  ]
}