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.

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.


{
    "profiles": [
        {
            "id": "oauth_profile_id",
            "name": "oauth_profile_id",
            "description": "oauth_profile_description"
            "authorizeURI": "oauth_authorizationcode_endpoint",
            "tokenURI": "oauth_token_endpoint",
            "scope": "oauth_scopes_list"
        },
        ...
    ]
}
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.
"authorizeURI" The endpoint for obtaining an authorization code from the data store. A valid URL for obtaining a code for authorization.
"tokenURI" The endpoint for retrieving access tokens from the data store. A valid URL for obtaining access and refresh tokens.
"scope" A space-separated list of OAuth scopes that limit the permissions granted by an access token at the time of connection. A user-specified list of space-separated scopes.

Sample Server Response 

  Status code: 200
  Successful response

{
    "profiles": [
        {
          "id": "33",
          "name": "Google_User_1",
          "description": "OAuth profile 1"
          "authorizeURI": "https://accounts.google.com/o/oauth2/v2/auth",
          "tokenURI": "https://www.googleapis.com/oauth2/v3/token",
          "scope": "full_offline_access, test_repo"
        },
        {
          "id": "39",
          "name": "Salesforce_User_2",
          "description": "OAuth profile 2"
          "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

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