apiKeyPair

Holds the key pair information used as an alternative way to using basic authorization for HTTP requests.

The public key is inserted as a query in the request URI. The secret key is then used to encode the entire URI to create a signature using HMAC_SHA1. This signature is then added to the end of the request URI.

These keys are created automatically by the platform. For more information, refer to API Key API Resources.

Attributes

The list of attributes for apiKeyPair are:

  • publicKey (string): the public key string
  • secretKey (string): the private key string
  • uri (anyURI): the resource uri of the APIKeyPair object
  • created (dateTime): the created date of the object
  • dbId (long): the database id of the object
  • digest (string): the digest value (used for etag)
  • lastModified (dateTime): the last modified date of this object