Chilkat Online Tools

PureBasic / ForgeRock Identity Cloud Collection / Step 3: Update a Managed Identity

Back to Collection Items

IncludeFile "CkJsonArray.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; [
    ;   {
    ;     "operation": "replace",
    ;     "field": "/telephoneNumber",
    ;     "value": "{{$randomPhoneNumber}}"
    ;   }
    ; ]

    jarr.i = CkJsonArray::ckCreate()
    If jarr.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckAddObjectAt(jarr,-1)
    jsonObj_1.i = CkJsonArray::ckObjectAt(jarr,CkJsonArray::ckSize(jarr) - 1)
    CkJsonObject::ckUpdateString(jsonObj_1,"operation","replace")
    CkJsonObject::ckUpdateString(jsonObj_1,"field","/telephoneNumber")
    CkJsonObject::ckUpdateString(jsonObj_1,"value","{{$randomPhoneNumber}}")
    CkJsonObject::ckDispose(jsonObj_1)

    CkHttp::ckSetRequestHeader(http,"X-OpenIDM-Username","{{adminUsername}}")
    CkHttp::ckSetRequestHeader(http,"Accept-API-Version","resource=1.0")
    CkHttp::ckSetRequestHeader(http,"X-OpenIDM-Password","{{adminPassword}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckEmitSb(jarr,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"POST","{{managedUsername}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonArray::ckDispose(jarr)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonArray::ckDispose(jarr)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Accept-API-Version: resource=1.0"
	-H "X-OpenIDM-Username: {{adminUsername}}"
	-H "X-OpenIDM-Password: {{adminPassword}}"
	-d '[
    {
        "operation": "replace",
        "field": "/telephoneNumber",
        "value": "{{$randomPhoneNumber}}"
    }
]'
https://<tenant-name>.forgeblocks.com/openidm/managed/alpha_user?_action=patch&_queryFilter=userName eq "{{managedUsername}}"

Postman Collection Item JSON

{
  "name": "Step 3: Update a Managed Identity",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "test",
      "script": {
        "exec": [
          "const jsonData = JSON.parse(responseBody);",
          "if(jsonData._id && jsonData._id != \"\"){",
          "    pm.globals.set(\"managedUserId\", jsonData._id);",
          "}"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "(Required) ",
        "key": "Accept-API-Version",
        "value": "resource=1.0",
        "disabled": true
      },
      {
        "key": "X-OpenIDM-Username",
        "type": "text",
        "value": "{{adminUsername}}"
      },
      {
        "key": "X-OpenIDM-Password",
        "type": "text",
        "value": "{{adminPassword}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "[\n    {\n        \"operation\": \"replace\",\n        \"field\": \"/telephoneNumber\",\n        \"value\": \"{{$randomPhoneNumber}}\"\n    }\n]",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{platformUrl}}/openidm/managed/alpha_user?_action=patch&_queryFilter=userName eq \"{{managedUsername}}\"",
      "host": [
        "{{platformUrl}}"
      ],
      "path": [
        "openidm",
        "managed",
        "alpha_user"
      ],
      "query": [
        {
          "key": "_action",
          "value": "patch"
        },
        {
          "key": "_queryFilter",
          "value": "userName eq \"{{managedUsername}}\""
        },
        {
          "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
        }
      ]
    },
    "description": "Update the details, in this case; the telephone number, of a managed identity."
  },
  "response": [
    {
      "name": "Success",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "<string>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/openidm/managed/user#1.0_query_filter?_fields=&_prettyPrint=true&_queryFilter=<string>&_pageSize=<integer>&_totalPagedResultsPolicy=<string>&_sortKeys=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "openidm",
            "managed",
            "user"
          ],
          "hash": "1.0_query_filter?_fields=&_prettyPrint=true&_queryFilter=<string>&_pageSize=<integer>&_totalPagedResultsPolicy=<string>&_sortKeys=<string>"
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "*/*"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}