Chilkat Online Tools

Ruby / Datadog API Collection / Create an AuthN Mapping

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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"
#         }
#       }
#     }
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("data.type","authn_mappings")
json.UpdateString("data.attributes.attribute_key","<string>")
json.UpdateString("data.attributes.attribute_value","<string>")
json.UpdateString("data.relationships.role.data.id","<string>")
json.UpdateString("data.relationships.role.data.type","roles")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/authn_mappings","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
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

Id = jResp.stringOf("data.id")
v_Type = jResp.stringOf("data.type")
Attribute_key = jResp.stringOf("data.attributes.attribute_key")
Attribute_value = jResp.stringOf("data.attributes.attribute_value")
Created_at = jResp.stringOf("data.attributes.created_at")
Modified_at = jResp.stringOf("data.attributes.modified_at")
Saml_assertion_attribute_id = jResp.stringOf("data.attributes.saml_assertion_attribute_id")
DataId = jResp.stringOf("data.relationships.role.data.id")
DataType = jResp.stringOf("data.relationships.role.data.type")
DataId = jResp.stringOf("data.relationships.saml_assertion_attribute.data.id")
DataType = jResp.stringOf("data.relationships.saml_assertion_attribute.data.type")
i = 0
count_i = jResp.SizeOfArray("included")
while i < count_i
    jResp.put_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
end

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}"
    }
  ]
}