Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateInt("page[size]",10)
success = queryParams.UpdateInt("page[number]",0)
success = queryParams.UpdateString("sort","name")
success = queryParams.UpdateString("filter","<string>")
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/roles/:role_id/users",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim Created_at As String
Dim Disabled As String
Dim v_Email As String
Dim Handle As String
Dim Icon As String
Dim Modified_at As String
Dim Name As String
Dim Service_account As String
Dim Status As String
Dim Title As String
Dim Verified As String
Dim id As String
Dim Id As String
Dim v_Type As String
Dim v_type As String
Dim j As Long
Dim count_j As Long
Dim attributesCreated_at As String
Dim Description As String
Dim attributesDisabled As String
Dim attributesModified_at As String
Dim attributesName As String
Dim Public_id As String
Dim Sharing As String
Dim v_Url As String
Dim Total_count As String
Total_count = jResp.StringOf("meta.page.total_count")
Dim Total_filtered_count As String
Total_filtered_count = jResp.StringOf("meta.page.total_filtered_count")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data")
Do 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")
Do 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
Loop
j = 0
count_j = jResp.SizeOfArray("data[i].relationships.other_users.data")
Do 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
Loop
j = 0
count_j = jResp.SizeOfArray("data[i].relationships.roles.data")
Do 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
Loop
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("included")
Do 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
Loop
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-d "sort=name"
-d "filter=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/roles/:role_id/users
Postman Collection Item JSON
{
"name": "Get all users of a role",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/users?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
}
],
"variable": [
{
"key": "role_id",
"value": "<string>"
}
]
},
"description": "Gets all users of a 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/users?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
}
],
"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": "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/users?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
}
],
"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/users?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
}
],
"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/users?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"users"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "User attribute to order results by. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign,\nfor example `sort=-name`. Options: `name`, `email`, `status`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all users by the given string. Defaults to no filtering."
}
],
"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}"
}
]
}
