digitaluapi

<back to all web services

RegenerateApiKeyRequest

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

Allowable Values

  • live
  • test
RegenerateApiKeysResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<UserApiKey>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
UserApiKey Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
KeyTypeformstringNo
ExpiryDateformDateTime?No
MetaformDictionary<string, string>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /auth/apikeys/regenerate HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Environment":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"Key":"String","KeyType":"String","ExpiryDate":"0001-01-01T00:00:00.0000000","Meta":{"String":"String"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}