Purpose

Returns the list of applications for which the logged-in user has been granted access.

URL

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

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,
            "scopes": [
                "string"
            ]
        },
        ..
        ..
}
Property Description Valid Values
"id" The application ID An auto-generated application ID.
"name" The name of the application A string with a maximum length of 128.
"scopes" An OAuth 2.0 scope specifies the resources that can be accessed by client applications. Currently, the only supported scope is "api.access.odata".

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
    "applications": [
        {
            "id": 1,
            "name": "TestOAuthApplication_1",
            "scopes": [
                "api.access.odata"
            ]
        },
        {
            "id": 3,
            "name": "TestOAuthApplication_2",
            "scopes": [
                "api.access.odata"
            ]
        }
    ]
}

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