AuthInfo

DatabaseTime-SeriesPostgreSQLOpen SourceCloudHypertablesContinuous AggregatesTiger Cloud

Properties

Name Type Description
type string The type of authentication being used
apiKey object Information about the API key credentials
View JSON Schema on GitHub

JSON Schema

timescaledb-authinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuthInfo",
  "title": "AuthInfo",
  "type": "object",
  "required": [
    "type",
    "apiKey"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of authentication being used",
      "enum": [
        "apiKey"
      ],
      "example": "apiKey"
    },
    "apiKey": {
      "type": "object",
      "description": "Information about the API key credentials",
      "required": [
        "public_key",
        "name",
        "created",
        "project",
        "issuing_user"
      ],
      "properties": {
        "public_key": {
          "type": "string",
          "description": "The public key of the client credentials",
          "example": "tskey_abc123"
        },
        "name": {
          "type": "string",
          "description": "The name of the credential",
          "example": "my-production-token"
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "description": "When the client credentials were created",
          "example": "2024-01-15T10:30:00Z"
        },
        "project": {
          "type": "object",
          "description": "Information about the project",
          "required": [
            "id",
            "name",
            "plan_type"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "The project ID",
              "example": "rp1pz7uyae"
            },
            "name": {
              "type": "string",
              "description": "The name of the project",
              "example": "My Production Project"
            },
            "plan_type": {
              "type": "string",
              "description": "The plan type for the project",
              "example": "FREE"
            }
          }
        },
        "issuing_user": {
          "type": "object",
          "description": "Information about the user who created the credentials",
          "required": [
            "id",
            "name",
            "email"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "The user ID",
              "example": "user123"
            },
            "name": {
              "type": "string",
              "description": "The user's name",
              "example": "John Doe"
            },
            "email": {
              "type": "string",
              "format": "email",
              "description": "The user's email",
              "example": "[email protected]"
            }
          }
        }
      }
    }
  }
}