Purpose

Updates the registered application by ID.

URL

https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Parameter Description Valid Values
"id" The application ID is automatically generated with the successful registration of the application. It must be a valid application ID.

Request Payload Parameters

The request payload is a JSON object with the following format: 
{
      "name": "app_name"
      "description":"app_description"
      "redirectUrls": [
       "redirect_url1","redirect_url2",...
      ]
}
Property Description Valid Values
"name" The name of the application A string with a maximum length of 128 characters.
"description" User specified description of the application. A string with a maximum length of 256 characters.
"redirectUrls" List of authorized URLs This may be one valid URL or a comma separated list of valid URLs.
"clientId" The client ID is generated when the client application is registered. This ID is required when client applications initiate OAuth authorization. An auto-generated value used when client applications initiate OAuth authorization.
"clientSecret" The client secret is generated when the client application is registered. This secret is required when client applications initiate OAuth authorization. An auto-generated value used when client applications initiate OAuth authorization.

Sample Payload


{
    "name": "Application3  for Update",
    "description": "Description of Application will all fields",
    "redirectUrls": [
    "test.sforcetest.com",
    "mor.progresstest.com"
     ]
}

Sample Server Success Response 


Status code: 200
OK
            
{
  "id": 22,
  "name": "Application3  for Update",
  "description": "Description of Application will all fields",
  "redirectUrls": [
  "test.sforcetest.com",
  "mor.progresstest.com"
  ]
}

Sample Server Failure Response 

{
   "error":{
      "code":222206632,
      "message":{
         "lang":"en-US",
         "value":"Problem updating OAuth Client Application at this time. Please try again at another time."
      }
   }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

Any active Hybrid Data Pipeline user