Cribl · Schema

ApiCredentialWithSecret

ConfigurationData LakeData PipelinesData RoutingEdge ComputingInfrastructure as CodeObservabilitySearchSecurity DataStream ProcessingTelemetry

Properties

Name	Type	Description
id	string	Unique identifier for the API credential
clientId	string	The OAuth 2.0 client ID
clientSecret	string	The OAuth 2.0 client secret. This value is only returned once at creation time and cannot be retrieved again.
description	string	A human-readable description
organizationId	string	The parent organization identifier
createdAt	string	Credential creation timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiCredentialWithSecret",
  "title": "ApiCredentialWithSecret",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the API credential"
    },
    "clientId": {
      "type": "string",
      "description": "The OAuth 2.0 client ID"
    },
    "clientSecret": {
      "type": "string",
      "description": "The OAuth 2.0 client secret. This value is only returned once at creation time and cannot be retrieved again."
    },
    "description": {
      "type": "string",
      "description": "A human-readable description"
    },
    "organizationId": {
      "type": "string",
      "description": "The parent organization identifier"
    },
    "createdAt": {
      "type": "string",
      "description": "Credential creation timestamp",
      "format": "date-time"
    }
  }
}