Purpose

Registers OAuth application. The execution of this request results in the generation of a client ID and client secret required for OAuth authentication.

URL

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

Method

POST

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.

Request Definition

{
   "name":"app_name",
   "description":"app_description",
   "redirectUrls":[
      "redirect_url1",
      "redirect_url2",
      "..."
   ]
}
Property Description Valid Values
"name" User specified 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"

User defined list of authorized URLs specified by the client. These are the URLs that the application should redirect to, on successful authorization.

 One or more valid URLs. You can enter multiple URLs, separated by commas.

Sample Payload

{
    "name":"Application1",
    "description":"Application1 for Create with all Fields",
    "redirectUrls":["bedford.progresstest.com","americas.progresstest.com"]
}

Response Definition

When the request is executed, a client ID and a client secret are generated. The parameters of the response are described in the table that follows.

{
   "id":"app_id",
   "name":"app_name",
   "description":"app_description",
   "redirectUrls":[
      "redirect_url1",
      "redirect_url2",
      "..."
   ],
   "clientId":"string",
   "clientSecret":"string"
}
Property Description Valid Values
"id" The application ID is automatically generated with the successful registration of the application. This ID is used for tracking applications in Hybrid Data Pipeline. An auto-generated application ID.
"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 Server Success Response 


Status code: 201
Created
            
{
    "id":19,
    "name":"Application1",
    "description":"Application1 for Create with all Fields",
    "redirectUrls":["bedford.progresstest.com","americas.progresstest.com"],
    "clientId":"eeee5555-66dd-7777-9999-fffff333333c",
    "clientSecret":"9999tttt-gg22-1212-0606-bbbbb444444z"
}

Sample Server Failure Response 

{
   "error":{
      "code":222206628,
      "message":{
         "lang":"en-US",
         "value":"Problem creating 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