Chilkat Online Tools

lianja / Datadog API Collection / List permissions for a role

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// 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

i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
    loJResp.I = i
    lcV_type = loJResp.StringOf("data[i].type")
    lcCreated = loJResp.StringOf("data[i].attributes.created")
    lcDescription = loJResp.StringOf("data[i].attributes.description")
    lcDisplay_name = loJResp.StringOf("data[i].attributes.display_name")
    lcDisplay_type = loJResp.StringOf("data[i].attributes.display_type")
    lcGroup_name = loJResp.StringOf("data[i].attributes.group_name")
    lcName = loJResp.StringOf("data[i].attributes.name")
    lcRestricted = loJResp.StringOf("data[i].attributes.restricted")
    lcId = loJResp.StringOf("data[i].id")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

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