Purpose

Returns list of OAuth registered applications.

URL

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

Method

GET

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.

Response Definition

The response takes the following format. The parameters of the response are described in the table that follows.

{
  "applications": [
    {
      "id":"app_id,
      "name": "app_name"
      "description":"app_description"
      "redirectUrls": [
       "redirect_url1","redirect_url2",...
      ]
    }
  ]
}
Property Description
"id" The application ID is an integer. It is automatically generated with the successful registration of the application.
"name" The user-specified name of the application.
"description" The user-specified description of the application.
"redirectUrls"

List of authorized URLs specified by the client. These are the URLs that the application should redirect to, on successful authorization. This may be one valid URL or a comma separated list of valid URLs.

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
    "id":19,
    "name":"Application1",
    "description":"Application1 for Create with all Fields",
    "redirectUrls":["bedford.progresstest.com","americas.progresstest.com"],
}

Sample Server Failure Response 

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