Chilkat Online Tools

phpExt / Auth0 Management API / Update a client

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

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

// {
//   "name": "",
//   "client_secret": "",
//   "logo_uri": "",
//   "callbacks": [
//     ""
//   ],
//   "allowed_origins": [
//     ""
//   ],
//   "client_aliases": [
//     ""
//   ],
//   "allowed_clients": [
//     ""
//   ],
//   "allowed_logout_urls": [
//     ""
//   ],
//   "jwt_configuration": {
//     "lifetime_in_seconds": 0,
//     "secret_encoded": true,
//     "scopes": {},
//     "alg": ""
//   },
//   "encryption_key": {
//     "pub": "",
//     "cert": "",
//     "subject": ""
//   },
//   "sso": true,
//   "custom_login_page_on": true,
//   "token_endpoint_auth_method": "",
//   "app_type": "",
//   "is_first_party": true,
//   "custom_login_page": "",
//   "custom_login_page_preview": "",
//   "form_template": "",
//   "addons": {
//     "aws": {},
//     "azure_blob": {},
//     "azure_sb": {},
//     "rms": {},
//     "mscrm": {},
//     "slack": {},
//     "box": {},
//     "cloudbees": {},
//     "concur": {},
//     "dropbox": {},
//     "echosign": {},
//     "egnyte": {},
//     "firebase": {},
//     "newrelic": {},
//     "office365": {},
//     "salesforce": {},
//     "salesforce_api": {},
//     "salesforce_sandbox_api": {},
//     "samlp": {},
//     "layer": {},
//     "sap_api": {},
//     "sharepoint": {},
//     "springcm": {},
//     "wams": {},
//     "wsfed": {},
//     "zendesk": {},
//     "zoom": {}
//   },
//   "resource_servers": [
//     {
//       "identifier": "",
//       "scopes": [
//         ""
//       ]
//     }
//   ],
//   "client_metadata": {},
//   "mobile": {
//     "android": {},
//     "ios": {}
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('name','');
$json->UpdateString('client_secret','');
$json->UpdateString('logo_uri','');
$json->UpdateString('callbacks[0]','');
$json->UpdateString('allowed_origins[0]','');
$json->UpdateString('client_aliases[0]','');
$json->UpdateString('allowed_clients[0]','');
$json->UpdateString('allowed_logout_urls[0]','');
$json->UpdateInt('jwt_configuration.lifetime_in_seconds',0);
$json->UpdateBool('jwt_configuration.secret_encoded',true);
$json->UpdateNewObject('jwt_configuration.scopes');
$json->UpdateString('jwt_configuration.alg','');
$json->UpdateString('encryption_key.pub','');
$json->UpdateString('encryption_key.cert','');
$json->UpdateString('encryption_key.subject','');
$json->UpdateBool('sso',true);
$json->UpdateBool('custom_login_page_on',true);
$json->UpdateString('token_endpoint_auth_method','');
$json->UpdateString('app_type','');
$json->UpdateBool('is_first_party',true);
$json->UpdateString('custom_login_page','');
$json->UpdateString('custom_login_page_preview','');
$json->UpdateString('form_template','');
$json->UpdateNewObject('addons.aws');
$json->UpdateNewObject('addons.azure_blob');
$json->UpdateNewObject('addons.azure_sb');
$json->UpdateNewObject('addons.rms');
$json->UpdateNewObject('addons.mscrm');
$json->UpdateNewObject('addons.slack');
$json->UpdateNewObject('addons.box');
$json->UpdateNewObject('addons.cloudbees');
$json->UpdateNewObject('addons.concur');
$json->UpdateNewObject('addons.dropbox');
$json->UpdateNewObject('addons.echosign');
$json->UpdateNewObject('addons.egnyte');
$json->UpdateNewObject('addons.firebase');
$json->UpdateNewObject('addons.newrelic');
$json->UpdateNewObject('addons.office365');
$json->UpdateNewObject('addons.salesforce');
$json->UpdateNewObject('addons.salesforce_api');
$json->UpdateNewObject('addons.salesforce_sandbox_api');
$json->UpdateNewObject('addons.samlp');
$json->UpdateNewObject('addons.layer');
$json->UpdateNewObject('addons.sap_api');
$json->UpdateNewObject('addons.sharepoint');
$json->UpdateNewObject('addons.springcm');
$json->UpdateNewObject('addons.wams');
$json->UpdateNewObject('addons.wsfed');
$json->UpdateNewObject('addons.zendesk');
$json->UpdateNewObject('addons.zoom');
$json->UpdateString('resource_servers[0].identifier','');
$json->UpdateString('resource_servers[0].scopes[0]','');
$json->UpdateNewObject('client_metadata');
$json->UpdateNewObject('mobile.android');
$json->UpdateNewObject('mobile.ios');

// Adds the "Authorization: Bearer {{auth0_token}}" header.
$http->put_AuthToken('{{auth0_token}}');
$http->SetRequestHeader('Content-Type','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PATCH','https://{{auth0_domain}}/api/v2/clients/:id',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X PATCH
	-H "Authorization: Bearer {{auth0_token}}"
	-H "Content-Type: application/json"
	-d '{
  "name": "",
  "client_secret": "",
  "logo_uri": "",
  "callbacks": [
    ""
  ],
  "allowed_origins": [
    ""
  ],
  "client_aliases": [
    ""
  ],
  "allowed_clients": [
    ""
  ],
  "allowed_logout_urls": [
    ""
  ],
  "jwt_configuration": {
    "lifetime_in_seconds": 0,
    "secret_encoded": true,
    "scopes": {},
    "alg": ""
  },
  "encryption_key": {
    "pub": "",
    "cert": "",
    "subject": ""
  },
  "sso": true,
  "custom_login_page_on": true,
  "token_endpoint_auth_method": "",
  "app_type": "",
  "is_first_party": true,
  "custom_login_page": "",
  "custom_login_page_preview": "",
  "form_template": "",
  "addons": {
    "aws": {},
    "azure_blob": {},
    "azure_sb": {},
    "rms": {},
    "mscrm": {},
    "slack": {},
    "box": {},
    "cloudbees": {},
    "concur": {},
    "dropbox": {},
    "echosign": {},
    "egnyte": {},
    "firebase": {},
    "newrelic": {},
    "office365": {},
    "salesforce": {},
    "salesforce_api": {},
    "salesforce_sandbox_api": {},
    "samlp": {},
    "layer": {},
    "sap_api": {},
    "sharepoint": {},
    "springcm": {},
    "wams": {},
    "wsfed": {},
    "zendesk": {},
    "zoom": {}
  },
  "resource_servers": [
    {
      "identifier": "",
      "scopes": [
        ""
      ]
    }
  ],
  "client_metadata": {},
  "mobile": {
    "android": {},
    "ios": {}
  }
}'
https://{{auth0_domain}}/api/v2/clients/:id

Postman Collection Item JSON

{
  "name": "Update a client",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{auth0_token}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n  \"name\": \"\",\r\n  \"client_secret\": \"\",\r\n  \"logo_uri\": \"\",\r\n  \"callbacks\": [\r\n    \"\"\r\n  ],\r\n  \"allowed_origins\": [\r\n    \"\"\r\n  ],\r\n  \"client_aliases\": [\r\n    \"\"\r\n  ],\r\n  \"allowed_clients\": [\r\n    \"\"\r\n  ],\r\n  \"allowed_logout_urls\": [\r\n    \"\"\r\n  ],\r\n  \"jwt_configuration\": {\r\n    \"lifetime_in_seconds\": 0,\r\n    \"secret_encoded\": true,\r\n    \"scopes\": {},\r\n    \"alg\": \"\"\r\n  },\r\n  \"encryption_key\": {\r\n    \"pub\": \"\",\r\n    \"cert\": \"\",\r\n    \"subject\": \"\"\r\n  },\r\n  \"sso\": true,\r\n  \"custom_login_page_on\": true,\r\n  \"token_endpoint_auth_method\": \"\",\r\n  \"app_type\": \"\",\r\n  \"is_first_party\": true,\r\n  \"custom_login_page\": \"\",\r\n  \"custom_login_page_preview\": \"\",\r\n  \"form_template\": \"\",\r\n  \"addons\": {\r\n    \"aws\": {},\r\n    \"azure_blob\": {},\r\n    \"azure_sb\": {},\r\n    \"rms\": {},\r\n    \"mscrm\": {},\r\n    \"slack\": {},\r\n    \"box\": {},\r\n    \"cloudbees\": {},\r\n    \"concur\": {},\r\n    \"dropbox\": {},\r\n    \"echosign\": {},\r\n    \"egnyte\": {},\r\n    \"firebase\": {},\r\n    \"newrelic\": {},\r\n    \"office365\": {},\r\n    \"salesforce\": {},\r\n    \"salesforce_api\": {},\r\n    \"salesforce_sandbox_api\": {},\r\n    \"samlp\": {},\r\n    \"layer\": {},\r\n    \"sap_api\": {},\r\n    \"sharepoint\": {},\r\n    \"springcm\": {},\r\n    \"wams\": {},\r\n    \"wsfed\": {},\r\n    \"zendesk\": {},\r\n    \"zoom\": {}\r\n  },\r\n  \"resource_servers\": [\r\n    {\r\n      \"identifier\": \"\",\r\n      \"scopes\": [\r\n        \"\"\r\n      ]\r\n    }\r\n  ],\r\n  \"client_metadata\": {},\r\n  \"mobile\": {\r\n    \"android\": {},\r\n    \"ios\": {}\r\n  }\r\n}"
    },
    "url": {
      "raw": "https://{{auth0_domain}}/api/v2/clients/:id",
      "protocol": "https",
      "host": [
        "{{auth0_domain}}"
      ],
      "path": [
        "api",
        "v2",
        "clients",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "type": "any"
        }
      ]
    },
    "description": "<strong>Important:</strong> The <code>client_secret</code> and <code>encryption_key</code> attributes can only be updated with the <code>update:client_keys</code> scope."
  },
  "response": [
  ]
}