Chilkat Online Tools

C++ / Datadog API Collection / Update a user

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    // 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": {
    //     "attributes": {
    //       "disabled": "<boolean>",
    //       "email": "<string>",
    //       "name": "<string>"
    //     },
    //     "type": "users",
    //     "id": "<string>"
    //   }
    // }

    CkJsonObject json;
    json.UpdateString("data.attributes.disabled","<boolean>");
    json.UpdateString("data.attributes.email","<string>");
    json.UpdateString("data.attributes.name","<string>");
    json.UpdateString("data.type","users");
    json.UpdateString("data.id","<string>");

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

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/users/:user_id",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": {
    //     "attributes": {
    //       "created_at": "<dateTime>",
    //       "disabled": "<boolean>",
    //       "email": "<string>",
    //       "handle": "<string>",
    //       "icon": "<string>",
    //       "modified_at": "<dateTime>",
    //       "name": "<string>",
    //       "service_account": "<boolean>",
    //       "status": "<string>",
    //       "title": "<string>",
    //       "verified": "<boolean>"
    //     },
    //     "id": "<string>",
    //     "relationships": {
    //       "org": {
    //         "data": {
    //           "id": "<string>",
    //           "type": "orgs"
    //         }
    //       },
    //       "other_orgs": {
    //         "data": [
    //           {
    //             "id": "<string>",
    //             "type": "orgs"
    //           },
    //           {
    //             "id": "<string>",
    //             "type": "orgs"
    //           }
    //         ]
    //       },
    //       "other_users": {
    //         "data": [
    //           {
    //             "id": "<string>",
    //             "type": "users"
    //           },
    //           {
    //             "id": "<string>",
    //             "type": "users"
    //           }
    //         ]
    //       },
    //       "roles": {
    //         "data": [
    //           {
    //             "id": "<string>",
    //             "type": "roles"
    //           },
    //           {
    //             "id": "<string>",
    //             "type": "roles"
    //           }
    //         ]
    //       }
    //     },
    //     "type": "users"
    //   },
    //   "included": [
    //     {
    //       "type": "orgs",
    //       "attributes": {
    //         "created_at": "<dateTime>",
    //         "description": "<string>",
    //         "disabled": "<boolean>",
    //         "modified_at": "<dateTime>",
    //         "name": "<string>",
    //         "public_id": "<string>",
    //         "sharing": "<string>",
    //         "url": "<string>"
    //       },
    //       "id": "<string>"
    //     },
    //     {
    //       "type": "orgs",
    //       "attributes": {
    //         "created_at": "<dateTime>",
    //         "description": "<string>",
    //         "disabled": "<boolean>",
    //         "modified_at": "<dateTime>",
    //         "name": "<string>",
    //         "public_id": "<string>",
    //         "sharing": "<string>",
    //         "url": "<string>"
    //       },
    //       "id": "<string>"
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *v_type = 0;
    const char *attributesCreated_at = 0;
    const char *Description = 0;
    const char *attributesDisabled = 0;
    const char *attributesModified_at = 0;
    const char *attributesName = 0;
    const char *Public_id = 0;
    const char *Sharing = 0;
    const char *v_Url = 0;

    const char *Created_at = jResp.stringOf("data.attributes.created_at");
    const char *Disabled = jResp.stringOf("data.attributes.disabled");
    const char *v_Email = jResp.stringOf("data.attributes.email");
    const char *Handle = jResp.stringOf("data.attributes.handle");
    const char *Icon = jResp.stringOf("data.attributes.icon");
    const char *Modified_at = jResp.stringOf("data.attributes.modified_at");
    const char *Name = jResp.stringOf("data.attributes.name");
    const char *Service_account = jResp.stringOf("data.attributes.service_account");
    const char *Status = jResp.stringOf("data.attributes.status");
    const char *Title = jResp.stringOf("data.attributes.title");
    const char *Verified = jResp.stringOf("data.attributes.verified");
    const char *Id = jResp.stringOf("data.id");
    const char *DataId = jResp.stringOf("data.relationships.org.data.id");
    const char *v_Type = jResp.stringOf("data.relationships.org.data.type");
    const char *dataType = jResp.stringOf("data.type");
    int i = 0;
    int count_i = jResp.SizeOfArray("data.relationships.other_orgs.data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("data.relationships.other_orgs.data[i].id");
        v_type = jResp.stringOf("data.relationships.other_orgs.data[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("data.relationships.other_users.data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("data.relationships.other_users.data[i].id");
        v_type = jResp.stringOf("data.relationships.other_users.data[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("data.relationships.roles.data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("data.relationships.roles.data[i].id");
        v_type = jResp.stringOf("data.relationships.roles.data[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("included");
    while (i < count_i) {
        jResp.put_I(i);
        v_type = jResp.stringOf("included[i].type");
        attributesCreated_at = jResp.stringOf("included[i].attributes.created_at");
        Description = jResp.stringOf("included[i].attributes.description");
        attributesDisabled = jResp.stringOf("included[i].attributes.disabled");
        attributesModified_at = jResp.stringOf("included[i].attributes.modified_at");
        attributesName = jResp.stringOf("included[i].attributes.name");
        Public_id = jResp.stringOf("included[i].attributes.public_id");
        Sharing = jResp.stringOf("included[i].attributes.sharing");
        v_Url = jResp.stringOf("included[i].attributes.url");
        id = jResp.stringOf("included[i].id");
        i = i + 1;
    }
    }

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "disabled": "<boolean>",
      "email": "<string>",
      "name": "<string>"
    },
    "type": "users",
    "id": "<string>"
  }
}'
https://api.app.ddog-gov.com/api/v2/users/:user_id

Postman Collection Item JSON

{
  "name": "Update a user",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"users\",\n    \"id\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Edit a user. Can only be used with an application key belonging\nto an administrator user."
  },
  "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    \"attributes\": {\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"users\",\n    \"id\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"handle\": \"<string>\",\n      \"icon\": \"<string>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\",\n      \"service_account\": \"<boolean>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\",\n      \"verified\": \"<boolean>\"\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"org\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"orgs\"\n        }\n      },\n      \"other_orgs\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          }\n        ]\n      },\n      \"other_users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      },\n      \"roles\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"roles\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"roles\"\n          }\n        ]\n      }\n    },\n    \"type\": \"users\"\n  },\n  \"included\": [\n    {\n      \"type\": \"orgs\",\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"description\": \"<string>\",\n        \"disabled\": \"<boolean>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"sharing\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"orgs\",\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"description\": \"<string>\",\n        \"disabled\": \"<boolean>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"sharing\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"id\": \"<string>\"\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    \"attributes\": {\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"users\",\n    \"id\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_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    \"attributes\": {\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"users\",\n    \"id\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_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    \"attributes\": {\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"users\",\n    \"id\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_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": "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    \"attributes\": {\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"users\",\n    \"id\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_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    \"attributes\": {\n      \"disabled\": \"<boolean>\",\n      \"email\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"users\",\n    \"id\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_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}"
    }
  ]
}