Back to Collection Items
<?php
// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("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": {
// "id": "<string>",
// "type": "users"
// }
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('data.id','<string>');
$json->UpdateString('data.type','users');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);
// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('DELETE','https://api.app.ddog-gov.com/api/v2/roles/:role_id/users',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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 = $jResp->stringOf('meta.page.total_count');
$Total_filtered_count = $jResp->stringOf('meta.page.total_filtered_count');
$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
$jResp->I = $i;
$Created_at = $jResp->stringOf('data[i].attributes.created_at');
$Disabled = $jResp->stringOf('data[i].attributes.disabled');
$v_Email = $jResp->stringOf('data[i].attributes.email');
$Handle = $jResp->stringOf('data[i].attributes.handle');
$Icon = $jResp->stringOf('data[i].attributes.icon');
$Modified_at = $jResp->stringOf('data[i].attributes.modified_at');
$Name = $jResp->stringOf('data[i].attributes.name');
$Service_account = $jResp->stringOf('data[i].attributes.service_account');
$Status = $jResp->stringOf('data[i].attributes.status');
$Title = $jResp->stringOf('data[i].attributes.title');
$Verified = $jResp->stringOf('data[i].attributes.verified');
$id = $jResp->stringOf('data[i].id');
$Id = $jResp->stringOf('data[i].relationships.org.data.id');
$v_Type = $jResp->stringOf('data[i].relationships.org.data.type');
$v_type = $jResp->stringOf('data[i].type');
$j = 0;
$count_j = $jResp->SizeOfArray('data[i].relationships.other_orgs.data');
while ($j < $count_j) {
$jResp->J = $j;
$id = $jResp->stringOf('data[i].relationships.other_orgs.data[j].id');
$v_type = $jResp->stringOf('data[i].relationships.other_orgs.data[j].type');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('data[i].relationships.other_users.data');
while ($j < $count_j) {
$jResp->J = $j;
$id = $jResp->stringOf('data[i].relationships.other_users.data[j].id');
$v_type = $jResp->stringOf('data[i].relationships.other_users.data[j].type');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('data[i].relationships.roles.data');
while ($j < $count_j) {
$jResp->J = $j;
$id = $jResp->stringOf('data[i].relationships.roles.data[j].id');
$v_type = $jResp->stringOf('data[i].relationships.roles.data[j].type');
$j = $j + 1;
}
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('included');
while ($i < $count_i) {
$jResp->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 DELETE
-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": "Remove a user from a role",
"request": {
"method": "DELETE",
"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": "Removes a user from a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"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": "DELETE",
"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": "DELETE",
"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": "DELETE",
"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": "DELETE",
"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}"
}
]
}
