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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"IsSuccessful":false,"Message":"String"}