Chilkat Online Tools

Python / ForgeRock Identity Cloud Collection / Step 2: Update Users' Device Profile

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.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.

# {
#   "alias": "{{$randomUserName}}'s Device",
#   "location": {
#     "longitude": "{{longitude}}",
#     "latitude": "{{latitude}}"
#   }
# }

json = chilkat2.JsonObject()
json.UpdateString("alias","{{$randomUserName}}'s Device")
json.UpdateString("location.longitude","{{longitude}}")
json.UpdateString("location.latitude","{{latitude}}")

http.SetRequestHeader("If-Match","*")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept-API-Version","resource=1.0")
http.SetRequestHeader("{{cookieName}}","{{demoSSOToken}}")

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/profile/:deviceProfileId?_prettyPrint=true#1.0_update",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -X PUT
	-H "Accept-API-Version: resource=1.0"
	-H "If-Match: *"
	-H "Content-Type: application/json"
	-H "{{cookieName}}: {{demoSSOToken}}"
	-d '{
    "alias": "{{$randomUserName}}\'s Device",
    "location": {
        "longitude": {{$randomLongitude}},
        "latitude": {{$randomLatitude}}
    }
}'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/profile/:deviceProfileId?_prettyPrint=true#1.0_update

Postman Collection Item JSON

{
  "name": "Step 2: Update Users' Device Profile",
  "request": {
    "method": "PUT",
    "header": [
      {
        "description": "(Required) ",
        "key": "Accept-API-Version",
        "value": "resource=1.0"
      },
      {
        "description": "(Required) ",
        "key": "If-Match",
        "value": "*"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "{{cookieName}}",
        "type": "text",
        "value": "{{demoSSOToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"alias\": \"{{$randomUserName}}'s Device\",\n    \"location\": {\n        \"longitude\": {{$randomLongitude}},\n        \"latitude\": {{$randomLatitude}}\n    }\n}"
    },
    "url": {
      "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile/:deviceProfileId?_prettyPrint=true#1.0_update",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "json{{realm}}",
        "users",
        ":user",
        "devices",
        "profile",
        ":deviceProfileId"
      ],
      "query": [
        {
          "key": "_fields",
          "value": "",
          "description": "Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.",
          "disabled": true
        },
        {
          "key": "_prettyPrint",
          "value": "true",
          "description": "Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable."
        }
      ],
      "hash": "1.0_update",
      "variable": [
        {
          "key": "user",
          "value": "{{demoUserId}}"
        },
        {
          "key": "deviceProfileId",
          "value": "{{deviceProfileId}}"
        }
      ]
    },
    "description": "Update an existing user device alias"
  },
  "response": [
    {
      "name": "Unexpected server error happened during the process",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          },
          {
            "description": "(Required) ",
            "key": "If-Match",
            "value": "*"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"identifier\": \"<string>\",\n    \"alias\": \"<string>\",\n    \"lastSelectedDate\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"location\": {\n        \"longitude\": 5910496.137554675,\n        \"latitude\": -41063633.84429224\n    }\n}"
        },
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile/{{identifier}}#1.0_update?&_prettyPrint=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "devices",
            "profile",
            "{{identifier}}"
          ],
          "hash": "1.0_update?&_prettyPrint=true",
          "variable": [
            {
              "key": "user"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": 93541721,\n \"message\": \"minim\",\n \"reason\": \"sint Excepteur\",\n \"detail\": \"veniam id qui\"\n}"
    },
    {
      "name": "Success",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          },
          {
            "description": "(Required) ",
            "key": "If-Match",
            "value": "*"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"identifier\": \"<string>\",\n    \"alias\": \"<string>\",\n    \"lastSelectedDate\": \"<string>\",\n    \"metadata\": \"<string>\",\n    \"location\": {\n        \"longitude\": 5910496.137554675,\n        \"latitude\": -41063633.84429224\n    }\n}"
        },
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile/{{identifier}}#1.0_update?&_prettyPrint=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "devices",
            "profile",
            "{{identifier}}"
          ],
          "hash": "1.0_update?&_prettyPrint=true",
          "variable": [
            {
              "key": "user"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "*/*"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}