WSO2 · Schema

API Key details to invoke APIs

APIKey schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
keyUUID	string	The UUID of the API key
keyName	string	API Key name
apiName	string	API Name
applicationName	string	Application Name
keyType	string	Application Key Type
user	string	Owner of the Application
issuedOn	integer	Created time in Unix epoch milliseconds
validityPeriod	integer
lastUsed	integer	Last used time in Unix epoch milliseconds

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/admin-api-api-key-schema.json",
  "title": "API Key details to invoke APIs",
  "description": "APIKey schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "keyUUID": {
      "type": "string",
      "description": "The UUID of the API key"
    },
    "keyName": {
      "type": "string",
      "description": "API Key name",
      "example": "Test_Key"
    },
    "apiName": {
      "type": "string",
      "description": "API Name",
      "example": "NotificationsAPI"
    },
    "applicationName": {
      "type": "string",
      "description": "Application Name",
      "example": "DefaultApplication"
    },
    "keyType": {
      "type": "string",
      "description": "Application Key Type",
      "example": "PRODUCTION",
      "enum": [
        "PRODUCTION",
        "SANDBOX"
      ]
    },
    "user": {
      "type": "string",
      "description": "Owner of the Application",
      "example": "Bob"
    },
    "issuedOn": {
      "type": "integer",
      "format": "int64",
      "description": "Created time in Unix epoch milliseconds",
      "example": 1599196134000
    },
    "validityPeriod": {
      "type": "integer",
      "format": "int64",
      "example": 3600
    },
    "lastUsed": {
      "type": "integer",
      "format": "int64",
      "nullable": true,
      "description": "Last used time in Unix epoch milliseconds",
      "example": 1599196134000
    }
  }
}