Lit Protocol · Schema

UpdateUsageApiKeyRequest

Request for update_usage_api_key. Updates all permissions and metadata on an existing usage API key. API key via header.

Web3Key ManagementMPCProgrammable KeysLit Actions

Properties

Name Type Description
usage_api_key string
name string
description string
can_create_groups boolean
can_delete_groups boolean
can_create_pkps boolean
manage_ipfs_ids_in_groups array Group IDs to grant manage-IPFS-IDs permission. 0 is wildcard for all groups.
add_pkp_to_groups array Group IDs to grant add-PKP permission. 0 is wildcard for all groups.
remove_pkp_from_groups array Group IDs to grant remove-PKP permission. 0 is wildcard for all groups.
execute_in_groups array Group IDs to grant execute permission. 0 is wildcard for all groups.
View JSON Schema on GitHub

JSON Schema

lit-protocol-updateusageapikeyrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateUsageApiKeyRequest",
  "title": "UpdateUsageApiKeyRequest",
  "description": "Request for update_usage_api_key. Updates all permissions and metadata on an existing usage API key. API key via header.",
  "type": "object",
  "required": [
    "add_pkp_to_groups",
    "can_create_groups",
    "can_create_pkps",
    "can_delete_groups",
    "description",
    "execute_in_groups",
    "manage_ipfs_ids_in_groups",
    "name",
    "remove_pkp_from_groups",
    "usage_api_key"
  ],
  "properties": {
    "usage_api_key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "can_create_groups": {
      "type": "boolean"
    },
    "can_delete_groups": {
      "type": "boolean"
    },
    "can_create_pkps": {
      "type": "boolean"
    },
    "manage_ipfs_ids_in_groups": {
      "description": "Group IDs to grant manage-IPFS-IDs permission. 0 is wildcard for all groups.",
      "type": "array",
      "items": {
        "type": "integer",
        "format": "uint64",
        "minimum": 0.0
      }
    },
    "add_pkp_to_groups": {
      "description": "Group IDs to grant add-PKP permission. 0 is wildcard for all groups.",
      "type": "array",
      "items": {
        "type": "integer",
        "format": "uint64",
        "minimum": 0.0
      }
    },
    "remove_pkp_from_groups": {
      "description": "Group IDs to grant remove-PKP permission. 0 is wildcard for all groups.",
      "type": "array",
      "items": {
        "type": "integer",
        "format": "uint64",
        "minimum": 0.0
      }
    },
    "execute_in_groups": {
      "description": "Group IDs to grant execute permission. 0 is wildcard for all groups.",
      "type": "array",
      "items": {
        "type": "integer",
        "format": "uint64",
        "minimum": 0.0
      }
    }
  }
}