| Requires any of the roles: | Client, Admin, Partner |
| GET | /auth/apikeys | ||
|---|---|---|---|
| GET | /auth/apikeys/{Environment} |
// @DataContract
export class UserApiKey implements IMeta
{
// @DataMember(Order=1)
public Key: string;
// @DataMember(Order=2)
public KeyType: string;
// @DataMember(Order=3)
public ExpiryDate?: string;
// @DataMember(Order=4)
public Meta: { [index:string]: string; };
public constructor(init?: Partial<UserApiKey>) { (Object as any).assign(this, init); }
}
// @DataContract
export class GetApiKeysResponse implements IMeta
{
// @DataMember(Order=1)
public Results: UserApiKey[];
// @DataMember(Order=2)
public Meta: { [index:string]: string; };
// @DataMember(Order=3)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetApiKeysResponse>) { (Object as any).assign(this, init); }
}
export class GetApiKeysRequest
{
/** @description Environment type */
// @ApiMember(Description="Environment type")
public Environment: string;
public constructor(init?: Partial<GetApiKeysRequest>) { (Object as any).assign(this, init); }
}
TypeScript GetApiKeysRequest DTOs
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
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/json
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"}}}