Web API Reference Guide > Data Types > Response Data Types > apikey

apikey

WebAPI key details.

Parameter

 Type

Count

Description

id

String

1

Success code, depends on the specific action, this may change (usually one of success | failure | warning).

username

String

1

Bound user for the api key. This user’s information is used for permissions and tracking purposes.

name

String

1

Name of the webapi key. Used for identification as part of the authentication signature header in a webapi request.

hash

String

1

Secret key part of the webapi key. This string is used to key the cryptographic hmac signature process.

creationTime

Date

1

ISO8061 formatted date string

creationTimestamp

Integer

1

Unix timestamp for the creationTime field.

Version: 1.3

 

Read Also

  Response Data Types