digitaluapi

<back to all web services

CancelApiKeysRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
DELETE/auth/apikeys/cancel
DELETE/auth/apikeys/cancel/{UserId}
DELETE/auth/apikeys/cancel/{UserId}/{Environment}
CancelApiKeysRequest Parameters:
NameParameterData TypeRequiredDescription
EnvironmentpathstringNoEnvironment type

Allowable Values

  • live
  • test
UserIdpathstringYesUser id
CancelApiKeysResponse Parameters:
NameParameterData TypeRequiredDescription
IsSuccessfulformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /auth/apikeys/cancel HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CancelApiKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
</CancelApiKeysResponse>