APIKey

Summary

API Manager API Key for use in authenticating applications

Description

API Manager API Key for use in authenticating applications

Fields

Field Name Type Since Version Description
id String The API Key ID which is used to identify applications. You include it in each request, so it's not a secret.
secret String Each API Key ID has a Secret Key associated with it. This key is just a long string of characters that can be used to calculate the digital signature that can be included in requests. Your Secret Key is a secret do not distribute.
enabled Boolean Flag disables the API key so can't be used in authentication
createdBy String The unique identifier for user that generated the API Key
createdOn Long Epoch/Unix time stamp when the API key was created
deletedOn Long Epoch/Unix time stamp when the API key was deleted
corsOrigins [String] The domains to allow access for browser-based clients

Example JSON

{
  "id" : "19da5d5e-b18a-4217-abec-291033cd939c",
  "secret" : "19da5d5e-b18a-4217-abec-291033cd939c",
  "enabled" : true,
  "createdBy" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "createdOn" : 1364287486876,
  "deletedOn" : 1364287486876,
  "corsOrigins" : [ "example.com" ]
}