Chilkat Online Tools

TCL / Datadog API Collection / List permissions for a role

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "data": [
#     {
#       "type": "permissions",
#       "attributes": {
#         "created": "<dateTime>",
#         "description": "<string>",
#         "display_name": "<string>",
#         "display_type": "<string>",
#         "group_name": "<string>",
#         "name": "<string>",
#         "restricted": "<boolean>"
#       },
#       "id": "<string>"
#     },
#     {
#       "type": "permissions",
#       "attributes": {
#         "created": "<dateTime>",
#         "description": "<string>",
#         "display_name": "<string>",
#         "display_type": "<string>",
#         "group_name": "<string>",
#         "name": "<string>",
#         "restricted": "<boolean>"
#       },
#       "id": "<string>"
#     }
#   ]
# }

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

set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
    set Created [CkJsonObject_stringOf $jResp "data[i].attributes.created"]
    set Description [CkJsonObject_stringOf $jResp "data[i].attributes.description"]
    set Display_name [CkJsonObject_stringOf $jResp "data[i].attributes.display_name"]
    set Display_type [CkJsonObject_stringOf $jResp "data[i].attributes.display_type"]
    set Group_name [CkJsonObject_stringOf $jResp "data[i].attributes.group_name"]
    set Name [CkJsonObject_stringOf $jResp "data[i].attributes.name"]
    set Restricted [CkJsonObject_stringOf $jResp "data[i].attributes.restricted"]
    set id [CkJsonObject_stringOf $jResp "data[i].id"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions

Postman Collection Item JSON

{
  "name": "List permissions for a role",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "roles",
        ":role_id",
        "permissions"
      ],
      "variable": [
        {
          "key": "role_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Returns a list of all permissions for a single role."
  },
  "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/roles/:role_id/permissions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id",
            "permissions"
          ],
          "variable": [
            {
              "key": "role_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"type\": \"permissions\",\n      \"attributes\": {\n        \"created\": \"<dateTime>\",\n        \"description\": \"<string>\",\n        \"display_name\": \"<string>\",\n        \"display_type\": \"<string>\",\n        \"group_name\": \"<string>\",\n        \"name\": \"<string>\",\n        \"restricted\": \"<boolean>\"\n      },\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"permissions\",\n      \"attributes\": {\n        \"created\": \"<dateTime>\",\n        \"description\": \"<string>\",\n        \"display_name\": \"<string>\",\n        \"display_type\": \"<string>\",\n        \"group_name\": \"<string>\",\n        \"name\": \"<string>\",\n        \"restricted\": \"<boolean>\"\n      },\n      \"id\": \"<string>\"\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/roles/:role_id/permissions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id",
            "permissions"
          ],
          "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": "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/roles/:role_id/permissions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id",
            "permissions"
          ],
          "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": "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/roles/:role_id/permissions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id",
            "permissions"
          ],
          "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}"
    }
  ]
}