Get OAuth applications

Purpose

Retrieves a list of OAuth application objects. OAuth application objects contain the authorization URL, token URL, scope, client ID, and client secret.

URL

https://<myserver>:<port>/api/mgmt/oauthapps

Filter by a query parameter

A user can also filter query results by tenant by appending the URL with a ?tenantId=<tenant_id> or ?tenantName=<tenant_name> query parameter. For example:

https://<myserver>:<port>/api/mgmt/oauthapps?tenantId=<tenant_id>

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.

{
    "applications": [
        {
            "id": oauth_application_id,
            "name": "oauth_application_name",
            "dataStore": data_store_id,
            "tenantId": tenant_id,
            "description": "oauth_application_description"
            "authorizeURI": "oauth_authorizationcode_endpoint",
            "tokenURI": "oauth_token_endpoint",
            "scope": "oauth_scopes_list"
        },
        ...
    ]
}	

Sample Server Response

     Status code: 200
     Successful response

{
    "applications": [
        {
          "id": "11",
          "name": "HDP system OAuth app",
          "dataStore": "54",
          "tenantId": 1,
          "description": "Hybrid Data Pipeline OAuth application object",
          "authorizeURI": "https://accounts.google.com/o/oauth2/v2/auth",
          "tokenURI": "https://www.googleapis.com/oauth2/v3/token",
          "scope": "full_offline_access, gist_repo"
        },
        {
          "id": "17",
          "name": "TenantA OAuth app",
          "dataStore": "1",
          "tenantId": 303,
          "description": "TenantA OAuth application object"
          "authorizeURI": "https://login.salesforce.com/services/oauth2/authorize",
          "tokenURI": "https://login.salesforce.com/services/oauth2/token",
          "scope": "full_offline_access, test_repo"
        }
      ]
}

Authentication

Basic Authentication using Login ID and Password

Authorization