Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Created_at: PWideChar;
Disabled: PWideChar;
v_Email: PWideChar;
Handle: PWideChar;
Icon: PWideChar;
Modified_at: PWideChar;
Name: PWideChar;
Service_account: PWideChar;
Status: PWideChar;
Title: PWideChar;
Verified: PWideChar;
id: PWideChar;
Id: PWideChar;
v_Type: PWideChar;
v_type: PWideChar;
j: Integer;
count_j: Integer;
attributesCreated_at: PWideChar;
Description: PWideChar;
attributesDisabled: PWideChar;
attributesModified_at: PWideChar;
attributesName: PWideChar;
Public_id: PWideChar;
Sharing: PWideChar;
v_Url: PWideChar;
Total_count: PWideChar;
Total_filtered_count: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// 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": "users"
// }
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'data.id','<string>');
CkJsonObject_UpdateString(json,'data.type','users');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_PostJson3(http,'https://api.app.ddog-gov.com/api/v2/roles/:role_id/users','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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"
// },
// {
// "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>"
// }
// ],
// "meta": {
// "page": {
// "total_count": "<long>",
// "total_filtered_count": "<long>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Total_count := CkJsonObject__stringOf(jResp,'meta.page.total_count');
Total_filtered_count := CkJsonObject__stringOf(jResp,'meta.page.total_filtered_count');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
Created_at := CkJsonObject__stringOf(jResp,'data[i].attributes.created_at');
Disabled := CkJsonObject__stringOf(jResp,'data[i].attributes.disabled');
v_Email := CkJsonObject__stringOf(jResp,'data[i].attributes.email');
Handle := CkJsonObject__stringOf(jResp,'data[i].attributes.handle');
Icon := CkJsonObject__stringOf(jResp,'data[i].attributes.icon');
Modified_at := CkJsonObject__stringOf(jResp,'data[i].attributes.modified_at');
Name := CkJsonObject__stringOf(jResp,'data[i].attributes.name');
Service_account := CkJsonObject__stringOf(jResp,'data[i].attributes.service_account');
Status := CkJsonObject__stringOf(jResp,'data[i].attributes.status');
Title := CkJsonObject__stringOf(jResp,'data[i].attributes.title');
Verified := CkJsonObject__stringOf(jResp,'data[i].attributes.verified');
id := CkJsonObject__stringOf(jResp,'data[i].id');
Id := CkJsonObject__stringOf(jResp,'data[i].relationships.org.data.id');
v_Type := CkJsonObject__stringOf(jResp,'data[i].relationships.org.data.type');
v_type := CkJsonObject__stringOf(jResp,'data[i].type');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'data[i].relationships.other_orgs.data');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
id := CkJsonObject__stringOf(jResp,'data[i].relationships.other_orgs.data[j].id');
v_type := CkJsonObject__stringOf(jResp,'data[i].relationships.other_orgs.data[j].type');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'data[i].relationships.other_users.data');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
id := CkJsonObject__stringOf(jResp,'data[i].relationships.other_users.data[j].id');
v_type := CkJsonObject__stringOf(jResp,'data[i].relationships.other_users.data[j].type');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'data[i].relationships.roles.data');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
id := CkJsonObject__stringOf(jResp,'data[i].relationships.roles.data[j].id');
v_type := CkJsonObject__stringOf(jResp,'data[i].relationships.roles.data[j].type');
j := j + 1;
end;
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'included');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
v_type := CkJsonObject__stringOf(jResp,'included[i].type');
attributesCreated_at := CkJsonObject__stringOf(jResp,'included[i].attributes.created_at');
Description := CkJsonObject__stringOf(jResp,'included[i].attributes.description');
attributesDisabled := CkJsonObject__stringOf(jResp,'included[i].attributes.disabled');
attributesModified_at := CkJsonObject__stringOf(jResp,'included[i].attributes.modified_at');
attributesName := CkJsonObject__stringOf(jResp,'included[i].attributes.name');
Public_id := CkJsonObject__stringOf(jResp,'included[i].attributes.public_id');
Sharing := CkJsonObject__stringOf(jResp,'included[i].attributes.sharing');
v_Url := CkJsonObject__stringOf(jResp,'included[i].attributes.url');
id := CkJsonObject__stringOf(jResp,'included[i].id');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "users"
}
}'
https://api.app.ddog-gov.com/api/v2/roles/:role_id/users
Postman Collection Item JSON
{
"name": "Add a user to a role",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id",
"value": "<string>"
}
]
},
"description": "Adds a user to a role."
},
"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 \"id\": \"<string>\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\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 {\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 ],\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 \"meta\": {\n \"page\": {\n \"total_count\": \"<long>\",\n \"total_filtered_count\": \"<long>\"\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 \"id\": \"<string>\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_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": "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 \"id\": \"<string>\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_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": "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 \"id\": \"<string>\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_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": "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 \"id\": \"<string>\",\n \"type\": \"users\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"variable": [
{
"key": "role_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}"
}
]
}
