Get OAuth profiles

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

Try Now

Get OAuth profiles

Purpose

Retrieves a list of OAuth profiles available to the user.

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/oauthprofiles

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.

{
"profiles": [
{
"id": "oauth_profile_id",
"name": "oauth_profile_id",
"description": "oauth_profile_description"
},
...
]
}

Property	Description	Valid Values
"id"	The ID of the OAuth profile.	The automatically generated OAuth profile ID.
"name"	The name of the OAuth profile.	The name can contain only alphanumeric characters and the underscore character.
"description"	A description of the OAuth profile.	A description provided by the user.

Sample Server Response

Status code: 200
Successful response

{
"profiles": [
{
"id": "33",
"name": "Google_User_1",
"description": "OAuth profile 1"
},
{
"id": "39",
"name": "Google_User_2",
"description": "OAuth profile 2"
}
]
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the MgmtAPI (11) and ViewDataSource (2) permissions.