Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCreated_at
LOCAL lcDisabled
LOCAL lcV_Email
LOCAL lcHandle
LOCAL lcIcon
LOCAL lcModified_at
LOCAL lcName
LOCAL lcService_account
LOCAL lcStatus
LOCAL lcTitle
LOCAL lcVerified
LOCAL lcId
LOCAL lcId
LOCAL lcV_Type
LOCAL lcV_type
LOCAL j
LOCAL lnCount_j
LOCAL lcAttributesCreated_at
LOCAL lcDescription
LOCAL lcAttributesDisabled
LOCAL lcAttributesModified_at
LOCAL lcAttributesName
LOCAL lcPublic_id
LOCAL lcSharing
LOCAL lcV_Url
LOCAL lcTotal_count
LOCAL lcTotal_filtered_count
LOCAL i
LOCAL lnCount_i
* 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 CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('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 CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("data.id","<string>")
loJson.UpdateString("data.type","users")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v2/roles/:role_id/users","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcTotal_count = loJResp.StringOf("meta.page.total_count")
lcTotal_filtered_count = loJResp.StringOf("meta.page.total_filtered_count")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
loJResp.I = i
lcCreated_at = loJResp.StringOf("data[i].attributes.created_at")
lcDisabled = loJResp.StringOf("data[i].attributes.disabled")
lcV_Email = loJResp.StringOf("data[i].attributes.email")
lcHandle = loJResp.StringOf("data[i].attributes.handle")
lcIcon = loJResp.StringOf("data[i].attributes.icon")
lcModified_at = loJResp.StringOf("data[i].attributes.modified_at")
lcName = loJResp.StringOf("data[i].attributes.name")
lcService_account = loJResp.StringOf("data[i].attributes.service_account")
lcStatus = loJResp.StringOf("data[i].attributes.status")
lcTitle = loJResp.StringOf("data[i].attributes.title")
lcVerified = loJResp.StringOf("data[i].attributes.verified")
lcId = loJResp.StringOf("data[i].id")
lcId = loJResp.StringOf("data[i].relationships.org.data.id")
lcV_Type = loJResp.StringOf("data[i].relationships.org.data.type")
lcV_type = loJResp.StringOf("data[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].relationships.other_orgs.data")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("data[i].relationships.other_orgs.data[j].id")
lcV_type = loJResp.StringOf("data[i].relationships.other_orgs.data[j].type")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].relationships.other_users.data")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("data[i].relationships.other_users.data[j].id")
lcV_type = loJResp.StringOf("data[i].relationships.other_users.data[j].type")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].relationships.roles.data")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("data[i].relationships.roles.data[j].id")
lcV_type = loJResp.StringOf("data[i].relationships.roles.data[j].type")
j = j + 1
ENDDO
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("included")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("included[i].type")
lcAttributesCreated_at = loJResp.StringOf("included[i].attributes.created_at")
lcDescription = loJResp.StringOf("included[i].attributes.description")
lcAttributesDisabled = loJResp.StringOf("included[i].attributes.disabled")
lcAttributesModified_at = loJResp.StringOf("included[i].attributes.modified_at")
lcAttributesName = loJResp.StringOf("included[i].attributes.name")
lcPublic_id = loJResp.StringOf("included[i].attributes.public_id")
lcSharing = loJResp.StringOf("included[i].attributes.sharing")
lcV_Url = loJResp.StringOf("included[i].attributes.url")
lcId = loJResp.StringOf("included[i].id")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
