Envestnet · Schema

ApiKeyOutput

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
expiresIn integer Time in seconds after which the JWT token created for users expires.

Endpoints:
  • GET /auth/apiKey
  • POST /auth/apiKey
createdDate string The date on which the apiKey was created for the customer.

Endpoints:
  • GET /auth/apiKey
  • POST /auth/apiKey
publicKey string Public key uploaded by the customer while generating ApiKey.

Endpoints:
  • GET /auth/apiKey
  • POST /auth/apiKey
key string ApiKey or the issuer key used to generate the JWT token for authentication.

Endpoints:
  • GET /auth/apiKey
  • POST /auth/apiKey
View JSON Schema on GitHub

JSON Schema

envestnet-apikeyoutput-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiKeyOutput",
  "title": "ApiKeyOutput",
  "type": "object",
  "properties": {
    "expiresIn": {
      "type": "integer",
      "description": "Time in seconds after which the JWT token created for users expires.<br><br><b>Endpoints</b>:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>",
      "format": "int64"
    },
    "createdDate": {
      "type": "string",
      "description": "The date on which the apiKey was created for the customer.<br><br><b>Endpoints</b>:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>"
    },
    "publicKey": {
      "maxLength": 2147483647,
      "minLength": 1,
      "type": "string",
      "description": "Public key uploaded by the customer while generating ApiKey.<br><br><b>Endpoints</b>:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>"
    },
    "key": {
      "type": "string",
      "description": "ApiKey or the issuer key used to generate the JWT token for authentication.<br><br><b>Endpoints</b>:<ul><li>GET /auth/apiKey</li><li>POST /auth/apiKey</li></ul>"
    }
  }
}