clerk.create_api_key

Parameters schema

{
  "type": "object",
  "title": "create_clerk_api_keyArguments",
  "required": [
    "name",
    "subject"
  ],
  "properties": {
    "name": {
      "type": "string",
      "title": "Name",
      "description": "Human-readable name for the new API key."
    },
    "claims": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "title": "Claims",
      "default": null,
      "description": "Custom claims to embed in tokens minted from this API key."
    },
    "scopes": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "type": "null"
        }
      ],
      "title": "Scopes",
      "default": null,
      "description": "Permission scopes to grant the API key."
    },
    "subject": {
      "type": "string",
      "title": "Subject",
      "description": "Subject the API key is scoped to (user_... or org_...)."
    },
    "key_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Key Type",
      "default": null,
      "description": "API key type (typically \"api_key\")."
    },
    "created_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By",
      "default": null,
      "description": "User id to record as the creator of this API key."
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description",
      "default": null,
      "description": "Optional description for the API key."
    },
    "clerk_instance_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clerk Instance Id",
      "default": null,
      "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account."
    },
    "seconds_until_expiration": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Seconds Until Expiration",
      "default": null,
      "description": "Seconds from creation until the API key expires."
    }
  }
}

No endpoints wrapped at confidence ≥ 0.70.

Parent server