Chilkat Online Tools

phpAx / MongoDB Atlas / Update One Organization API Key

Back to Collection Items

<?php

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

$http = new COM("Chilkat.Http");

$http->DigestAuth = 1;
$http->Login = 'username';
$http->Password = 'password';

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

// The following JSON is sent in the request body.

// {
//   "desc": "Updated API key description for test purposes",
//   "roles": [
//     "ORG_MEMBER",
//     "ORG_READ_ONLY"
//   ]
// }

$json = new COM("Chilkat.JsonObject");
$json->UpdateString('desc','Updated API key description for test purposes');
$json->UpdateString('roles[0]','ORG_MEMBER');
$json->UpdateString('roles[1]','ORG_READ_ONLY');

$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

$resp = new COM("Chilkat.HttpResponse");
$success = $http->HttpSb('PATCH','https://domain.com/api/atlas/{{version}}/orgs/{{ORG-ID}}/apiKeys/{{API-KEY-ID}}',$sbRequestBody,'utf-8','application/json',$resp);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";

?>

Curl Command

curl -X PATCH
	--digest -u 'username:password'
	-d '{
    "desc": "Updated API key description for test purposes",
    "roles": [
        "ORG_MEMBER",
        "ORG_READ_ONLY"
    ]
}'
https://domain.com/api/atlas/{{version}}/orgs/{{ORG-ID}}/apiKeys/{{API-KEY-ID}}

Postman Collection Item JSON

{
  "name": "Update One Organization API Key",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"desc\": \"Updated API key description for test purposes\",\n    \"roles\": [\n        \"ORG_MEMBER\",\n        \"ORG_READ_ONLY\"\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/orgs/{{ORG-ID}}/apiKeys/{{API-KEY-ID}}",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "orgs",
        "{{ORG-ID}}",
        "apiKeys",
        "{{API-KEY-ID}}"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/apiKeys-orgs-update-one/"
  },
  "response": [
  ]
}