Ampersand · Schema

PatchJWTKeyRequest

PatchJWTKeyRequest schema from Ampersand API

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
updateMask array List of field paths to update (currently supports 'active' and 'name')
jwtKey object Object containing the fields to update with their new values
View JSON Schema on GitHub

JSON Schema

ampersand-api-patch-jwt-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-patch-jwt-key-request-schema.json",
  "title": "PatchJWTKeyRequest",
  "description": "PatchJWTKeyRequest schema from Ampersand API",
  "type": "object",
  "properties": {
    "updateMask": {
      "type": "array",
      "description": "List of field paths to update (currently supports 'active' and 'name')",
      "items": {
        "type": "string",
        "enum": [
          "active",
          "label"
        ]
      },
      "minItems": 1,
      "example": [
        "active",
        "label"
      ]
    },
    "jwtKey": {
      "type": "object",
      "description": "Object containing the fields to update with their new values",
      "additionalProperties": true,
      "properties": {
        "active": {
          "type": "boolean",
          "description": "New active status for the JWT key",
          "example": false
        },
        "label": {
          "type": "string",
          "description": "New label for the JWT key",
          "example": "updated-key-name"
        }
      },
      "example": {
        "active": false,
        "name": "updated-key-name"
      }
    }
  },
  "required": [
    "updateMask",
    "jwtKey"
  ]
}