Create an OAuth application object

Purpose

Creates an OAuth application object that holds the authorization URL, token URL, scope, client ID, and client secret. An OAuth application ID is automatically generated. This ID is used to link an OAuth application with an OAuth profile.

URL

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

Method

POST

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.

Request Definition

The request takes the following format.

{
   "name": "oauth_application_name",
   "dataStore": data_store_id,
   "tenantId": tenant_id,
   "description": "oauth_application_description",
   "clientId": "client_id",
   "clientSecret": "client_secret"
   "authorizeURI": "oauth_authorizationcode_endpoint",
   "tokenURI": "oauth_token_endpoint",
   "scope": "oauth_scopes_list"
}

Sample Request Payload

{
  "name": "TenantA OAuth app",
  "dataStore": 54,
  "tenantId": 303,
  "description": "TenantA OAuth application object",
  "clientId": "asdfjasdljfasdkjf",
  "clientSecret": "1912308409123890"
  "authorizeURI": "https://accounts.google.com/o/oauth2/v2/auth",
  "tokenURI": "https://www.googleapis.com/oauth2/v3/token",
  "scope": "full_offline_access, test_repo"
}

Sample Server Response

  Status code: 201
  Successful response

{
  "id": "17",
  "name": "TenantA OAuth app",
  "dataStore": 54,
  "tenantId": 303,
  "description": "TenantA OAuth application object",
  "clientId": "asdfjasdljfasdkjf",
  "clientSecret": "1912308409123890"
  "authorizeURI": "https://accounts.google.com/o/oauth2/v2/auth",
  "tokenURI": "https://www.googleapis.com/oauth2/v3/token",
  "scope": "full_offline_access, test_repo"
}

Authentication

Basic Authentication using Login ID and Password.

Authorization