| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetApiKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Results>
<UserApiKey>
<Key>String</Key>
<KeyType>String</KeyType>
<ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</UserApiKey>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</GetApiKeysResponse>