Purpose

Deletes an OAuth profile. Deleting an OAuth profile removes its references from data sources.

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/{id}

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.

The URL parameter {id} is required.

Parameter Description Valid Values
{id} The ID of the OAuth profile. The automatically generated OAuth profile ID.

Method

DELETE

Sample Server Success Response

  Status code: 204
  Successful response

{
  "success":true
}

Sample Server Failure Response 


{
  "error": {
    "code": "222207710",
    "message": {
      "lang": "en-US",
      "value": "Invalid OAuthProfileId: 30"
     }
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and DeleteDataSource (4) permissions.