Ampersand · JSON Structure

Ampersand Api Patch Jwt Key Request Structure

PatchJWTKeyRequest schema from Ampersand API

Type: object Properties: 2 Required: 2
Developer ToolsIntegrationPlatformSoftware-as-a-ServiceAuthenticationData SyncWebhook

PatchJWTKeyRequest is a JSON Structure definition published by Ampersand, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

updateMask jwtKey

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-patch-jwt-key-request-structure.json",
  "name": "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"
  ]
}