Ampersand · Schema

ApiKeyRequest

ApiKeyRequest schema from Ampersand API

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
label string A short name for the API key.
scopes object
View JSON Schema on GitHub

JSON Schema

ampersand-api-api-key-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-api-key-request-schema.json",
  "title": "ApiKeyRequest",
  "description": "ApiKeyRequest schema from Ampersand API",
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "description": "A short name for the API key.",
      "example": "MailMonkey API Key"
    },
    "scopes": {
      "$ref": "#/components/schemas/ApiKeyScopes"
    }
  },
  "required": [
    "label"
  ]
}