Biogen · Schema

ApiKey

A developer API key for accessing Biogen services.

BiotechnologyHealthcareLife SciencesPharmaceuticalsNeurologyFortune 500

Properties

Name Type Description
id string Key ID.
name string Key display name.
key string The API key value (shown once at creation).
status string Key status.
created_at string Key creation timestamp.
usage object
View JSON Schema on GitHub

JSON Schema

biogen-api-key-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApiKey",
  "type": "object",
  "description": "A developer API key for accessing Biogen services.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Key ID.",
      "example": "key-abc123"
    },
    "name": {
      "type": "string",
      "description": "Key display name.",
      "example": "Production Key"
    },
    "key": {
      "type": "string",
      "description": "The API key value (shown once at creation).",
      "example": "bde7f3..."
    },
    "status": {
      "type": "string",
      "description": "Key status.",
      "enum": [
        "active",
        "inactive",
        "revoked"
      ],
      "example": "active"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Key creation timestamp.",
      "example": "2024-01-01T00:00:00Z"
    },
    "usage": {
      "$ref": "#/components/schemas/ApiKeyUsage"
    }
  }
}