Get OAuth applications

Hybrid Data Pipeline API reference : Management API : OAuth API for Google Analytics connectivity : OAuth applications API : Get OAuth applications

Try Now

Purpose

Retrieves a list of OAuth application objects. OAuth application objects contain the OAuth cleint ID and secret.

Note: An administrator can execute this operation on behalf of a user by appending the user query parameter to the request and specifying a user name. See also Managing resources on behalf of users.

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 standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <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"
},
...
]
}

Property	Description	Valid Values
"id"	The ID of the OAuth application object.	The automatically generated OAuth application ID.
"name"	The name of the OAuth application object.	The user-specified name of the OAuth application object. The name can contain only alphanumeric characters and the underscore character.
"dataStore"	The ID of the data store for which the OAuth application object is being created.	The only data store which Hybrid Data Pipeline currently supports access to is Google Analytics. Therefore, the only valid value is the Google Analytics data store ID: 54.
"tenantId"	The ID of the tenant to which the OAuth application and data store belong.	A valid tenant ID.
"description"	A description of the OAuth application object.	A description provided by the user.

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 for Google Analytics"
},
{
"id": "17",
"name": "TenantA OAuth app",
"dataStore": "54",
"tenantId": 303,
"description": "TenantA OAuth application object for Google Analytics"
}
]
}

Authentication

Basic Authentication using Login ID and Password

Authorization

Permissions apply in the following manner.

With the Administrator (12) permission, a user can view all OAuth application objects across the system.

With the MgmtAPI (11) and OAuth (28) permissions, a user in the system tenant can view existing OAuth application objects in the system tenant and in any tenants for which he or she has administrative access.

With the MgmtAPI (11) and OAuth (28) permissions, a user in a child tenant can only view OAuth application objects in the tenant in which he or she resides.