| Requires any of the roles: | Client, Admin, Partner |
| GET | /auth/apikeys | ||
|---|---|---|---|
| GET | /auth/apikeys/{Environment} |
"use strict";
export class UserApiKey {
/** @param {{Key?:string,KeyType?:string,ExpiryDate?:string,Meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
KeyType;
/** @type {?string} */
ExpiryDate;
/** @type {{ [index:string]: string; }} */
Meta;
}
export class GetApiKeysResponse {
/** @param {{Results?:UserApiKey[],Meta?:{ [index:string]: string; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {UserApiKey[]} */
Results;
/** @type {{ [index:string]: string; }} */
Meta;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetApiKeysRequest {
/** @param {{Environment?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Environment type */
Environment;
}
JavaScript GetApiKeysRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /auth/apikeys HTTP/1.1 Host: duengageapi.uat.scadsoftware.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}