| Requires any of the roles: | Client, Admin, Partner |
| GET | /auth/apikeys | ||
|---|---|---|---|
| GET | /auth/apikeys/{Environment} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Environment | path | string | No | Environment typeAllowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | List<UserApiKey> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| KeyType | form | string | No | |
| ExpiryDate | form | DateTime? | No | |
| Meta | form | Dictionary<string, string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Results:
[
{
Key: String,
KeyType: String,
ExpiryDate: 0001-01-01,
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
}
}
}