{ "service": "keygen", "displayName": "Keygen", "categories": [ "Developer Tools", "Security" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Token", "placeholder": "keygen_api_token", "description": "Keygen API token sent with the Authorization Bearer header. Generate an environment or product token from the Keygen dashboard or token API: https://keygen.sh/docs/api/authentication/", "extraFields": [ { "key": "account", "label": "Account ID or Slug", "inputType": "text", "required": true, "secret": false, "placeholder": "demo", "description": "The Keygen account UUID or slug used in /v1/accounts/. Find it in Account Settings under Current Account: https://keygen.sh/docs/api/#your-keygen-account" } ] } ], "homepageUrl": "https://keygen.sh", "actions": [ { "id": "keygen.activate_machine", "service": "keygen", "name": "activate_machine", "description": "Activate a machine in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen machine resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.attach_license_entitlements", "service": "keygen", "name": "attach_license_entitlements", "description": "Attach entitlements to a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "entitlementIds": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A related Keygen resource ID." }, "description": "The Keygen entitlement IDs to attach to the license.", "minItems": 1 } }, "additionalProperties": false, "description": "Input parameters for updating Keygen license entitlements." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.attach_license_users", "service": "keygen", "name": "attach_license_users", "description": "Attach users to a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "userIds": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A related Keygen resource ID." }, "description": "The Keygen user IDs to attach to the license.", "minItems": 1 } }, "additionalProperties": false, "description": "Input parameters for updating Keygen license users." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.attach_policy_entitlements", "service": "keygen", "name": "attach_policy_entitlements", "description": "Attach entitlements to a Keygen policy.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "entitlementIds": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A related Keygen resource ID." }, "description": "The Keygen entitlement IDs to attach to the policy.", "minItems": 1 } }, "additionalProperties": false, "description": "Input parameters for updating Keygen policy entitlements." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.ban_user", "service": "keygen", "name": "ban_user", "description": "Ban a Keygen user from authenticating.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen user resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen user resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.change_license_group", "service": "keygen", "name": "change_license_group", "description": "Change the group assigned to a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "groupId": { "type": "string", "minLength": 1, "description": "The Keygen group ID to assign to the license." } }, "additionalProperties": false, "description": "Input parameters for changing a Keygen license group." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.change_license_owner", "service": "keygen", "name": "change_license_owner", "description": "Change the owner user for a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "userId": { "type": "string", "minLength": 1, "description": "The Keygen user ID to assign as the license owner." } }, "additionalProperties": false, "description": "Input parameters for changing a Keygen license owner." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.change_license_policy", "service": "keygen", "name": "change_license_policy", "description": "Move a Keygen license to another policy.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "policyId": { "type": "string", "minLength": 1, "description": "The Keygen policy ID to assign to the license." } }, "additionalProperties": false, "description": "Input parameters for changing a Keygen license policy." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.change_machine_group", "service": "keygen", "name": "change_machine_group", "description": "Change the group assigned to a Keygen machine.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "groupId": { "type": "string", "minLength": 1, "description": "The Keygen group ID to assign to the machine." } }, "additionalProperties": false, "description": "Input parameters for changing a Keygen machine group." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.change_machine_owner", "service": "keygen", "name": "change_machine_owner", "description": "Change the owner user for a Keygen machine.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "userId": { "type": "string", "minLength": 1, "description": "The Keygen user ID to assign as the machine owner." } }, "additionalProperties": false, "description": "Input parameters for changing a Keygen machine owner." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.change_user_group", "service": "keygen", "name": "change_user_group", "description": "Move a Keygen user to another group.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "groupId": { "type": "string", "minLength": 1, "description": "The Keygen group ID to assign to the user." } }, "additionalProperties": false, "description": "Input parameters for changing a Keygen user group." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.check_in_license", "service": "keygen", "name": "check_in_license", "description": "Check in a Keygen license for policies that require periodic license check-ins.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_component", "service": "keygen", "name": "create_component", "description": "Create a machine component in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen component resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_entitlement", "service": "keygen", "name": "create_entitlement", "description": "Create an entitlement in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen entitlement resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_group", "service": "keygen", "name": "create_group", "description": "Create a group in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen group resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_license", "service": "keygen", "name": "create_license", "description": "Create a license in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_policy", "service": "keygen", "name": "create_policy", "description": "Create a license policy in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen policy resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_process", "service": "keygen", "name": "create_process", "description": "Create a tracked process in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen process resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_product", "service": "keygen", "name": "create_product", "description": "Create a product in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen product resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.create_user", "service": "keygen", "name": "create_user", "description": "Create a user in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "attributes" ], "description": "Input parameters for creating a Keygen user resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.deactivate_machine", "service": "keygen", "name": "deactivate_machine", "description": "Deactivate a machine from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen machine resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen machine resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.decrement_license_usage", "service": "keygen", "name": "decrement_license_usage", "description": "Decrement metered usage for a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." }, "decrement": { "type": "integer", "minimum": 1, "description": "The usage amount to decrement. Keygen defaults to 1 when omitted." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for the Keygen decrement license usage action." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.delete_component", "service": "keygen", "name": "delete_component", "description": "Delete a machine component from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen component resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen component resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.delete_entitlement", "service": "keygen", "name": "delete_entitlement", "description": "Delete an entitlement from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen entitlement resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen entitlement resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.delete_group", "service": "keygen", "name": "delete_group", "description": "Delete a group from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen group resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen group resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.delete_license", "service": "keygen", "name": "delete_license", "description": "Delete a license from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.delete_policy", "service": "keygen", "name": "delete_policy", "description": "Delete a license policy from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen policy resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen policy resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.delete_process", "service": "keygen", "name": "delete_process", "description": "Delete a tracked process from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen process resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen process resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.delete_product", "service": "keygen", "name": "delete_product", "description": "Delete a product from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen product resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen product resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.delete_user", "service": "keygen", "name": "delete_user", "description": "Delete a user from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen user resource ID." } }, "additionalProperties": false, "description": "Input parameters for deleting one Keygen user resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.detach_license_entitlements", "service": "keygen", "name": "detach_license_entitlements", "description": "Detach entitlements from a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "entitlementIds": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A related Keygen resource ID." }, "description": "The Keygen entitlement IDs to detach from the license.", "minItems": 1 } }, "additionalProperties": false, "description": "Input parameters for updating Keygen license entitlements." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.detach_license_users", "service": "keygen", "name": "detach_license_users", "description": "Detach users from a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "userIds": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A related Keygen resource ID." }, "description": "The Keygen user IDs to detach from the license.", "minItems": 1 } }, "additionalProperties": false, "description": "Input parameters for updating Keygen license users." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.detach_policy_entitlements", "service": "keygen", "name": "detach_policy_entitlements", "description": "Detach entitlements from a Keygen policy.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "entitlementIds": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A related Keygen resource ID." }, "description": "The Keygen entitlement IDs to detach from the policy.", "minItems": 1 } }, "additionalProperties": false, "description": "Input parameters for updating Keygen policy entitlements." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.increment_license_usage", "service": "keygen", "name": "increment_license_usage", "description": "Increment metered usage for a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." }, "increment": { "type": "integer", "minimum": 1, "description": "The usage amount to increment. Keygen defaults to 1 when omitted." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for the Keygen increment license usage action." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_components", "service": "keygen", "name": "list_components", "description": "List machine components in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen component resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_entitlements", "service": "keygen", "name": "list_entitlements", "description": "List entitlements in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen entitlement resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_groups", "service": "keygen", "name": "list_groups", "description": "List groups in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen group resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_license_entitlements", "service": "keygen", "name": "list_license_entitlements", "description": "List entitlements attached to a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "limit": { "type": "integer", "minimum": 1, "description": "The maximum number of related resources to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The Keygen cursor page size to request." }, "pageCursor": { "type": "string", "minLength": 1, "description": "The Keygen cursor value for the page to return." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for listing Keygen license entitlements." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_license_users", "service": "keygen", "name": "list_license_users", "description": "List users attached to a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "limit": { "type": "integer", "minimum": 1, "description": "The maximum number of related resources to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The Keygen cursor page size to request." }, "pageCursor": { "type": "string", "minLength": 1, "description": "The Keygen cursor value for the page to return." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for listing Keygen license users." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_licenses", "service": "keygen", "name": "list_licenses", "description": "List licenses in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen license resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_machines", "service": "keygen", "name": "list_machines", "description": "List activated machines in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen machine resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_policies", "service": "keygen", "name": "list_policies", "description": "List license policies in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen policy resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_policy_entitlements", "service": "keygen", "name": "list_policy_entitlements", "description": "List entitlements attached to a Keygen policy.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The parent Keygen resource ID." }, "limit": { "type": "integer", "minimum": 1, "description": "The maximum number of related resources to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The Keygen cursor page size to request." }, "pageCursor": { "type": "string", "minLength": 1, "description": "The Keygen cursor value for the page to return." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for listing Keygen policy entitlements." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_processes", "service": "keygen", "name": "list_processes", "description": "List tracked processes in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen process resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_products", "service": "keygen", "name": "list_products", "description": "List products in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen product resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.list_users", "service": "keygen", "name": "list_users", "description": "List users in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The page number to return from Keygen." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of resources to request from Keygen." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Keygen relationship names to include in the response." }, "filter": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "String query value." }, { "type": "number", "description": "Numeric query value." }, { "type": "boolean", "description": "Boolean query value." } ], "description": "A string, number, or boolean query value." }, "description": "Multiple values for the same Keygen query field." } ], "description": "A Keygen query value." }, "description": "Keygen JSON:API filters keyed by filter name. Values are serialized as filter[key] query parameters." } }, "additionalProperties": false, "description": "Input parameters for listing Keygen user resources." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.ping_machine", "service": "keygen", "name": "ping_machine", "description": "Ping a Keygen machine heartbeat.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen machine resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen machine resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.ping_process", "service": "keygen", "name": "ping_process", "description": "Ping a Keygen process heartbeat.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen process resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen process resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.reinstate_license", "service": "keygen", "name": "reinstate_license", "description": "Reinstate a suspended Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.renew_license", "service": "keygen", "name": "renew_license", "description": "Renew a Keygen license according to its policy.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.reset_license_usage", "service": "keygen", "name": "reset_license_usage", "description": "Reset metered usage for a Keygen license.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.reset_machine_heartbeat", "service": "keygen", "name": "reset_machine_heartbeat", "description": "Reset a Keygen machine heartbeat.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen machine resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen machine resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_component", "service": "keygen", "name": "retrieve_component", "description": "Retrieve one machine component from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen component resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen component resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_entitlement", "service": "keygen", "name": "retrieve_entitlement", "description": "Retrieve one entitlement from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen entitlement resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen entitlement resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_group", "service": "keygen", "name": "retrieve_group", "description": "Retrieve one group from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen group resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen group resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_license", "service": "keygen", "name": "retrieve_license", "description": "Retrieve one license from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_machine", "service": "keygen", "name": "retrieve_machine", "description": "Retrieve one activated machine from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen machine resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen machine resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_policy", "service": "keygen", "name": "retrieve_policy", "description": "Retrieve one license policy from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen policy resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen policy resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_process", "service": "keygen", "name": "retrieve_process", "description": "Retrieve one tracked process from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen process resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen process resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_product", "service": "keygen", "name": "retrieve_product", "description": "Retrieve one product from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen product resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen product resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.retrieve_user", "service": "keygen", "name": "retrieve_user", "description": "Retrieve one user from the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen user resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen user resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.revoke_license", "service": "keygen", "name": "revoke_license", "description": "Revoke a Keygen license through the official revoke action.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether Keygen accepted the delete request." }, "data": { "description": "The raw Keygen response body, or null when Keygen returned no body." } }, "additionalProperties": false, "required": [ "deleted" ], "description": "The normalized deletion result returned by the connector." } }, { "id": "keygen.suspend_license", "service": "keygen", "name": "suspend_license", "description": "Suspend a Keygen license so it can no longer authenticate with the API.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.unban_user", "service": "keygen", "name": "unban_user", "description": "Unban a Keygen user so they can authenticate again.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen user resource ID." } }, "additionalProperties": false, "description": "Input parameters for retrieving one Keygen user resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_component", "service": "keygen", "name": "update_component", "description": "Update a machine component in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen component resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen component resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_entitlement", "service": "keygen", "name": "update_entitlement", "description": "Update an entitlement in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen entitlement resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen entitlement resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_group", "service": "keygen", "name": "update_group", "description": "Update a group in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen group resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen group resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_license", "service": "keygen", "name": "update_license", "description": "Update a license in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen license resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_machine", "service": "keygen", "name": "update_machine", "description": "Update an activated machine in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen machine resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen machine resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_policy", "service": "keygen", "name": "update_policy", "description": "Update a license policy in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen policy resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen policy resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_process", "service": "keygen", "name": "update_process", "description": "Update a tracked process in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen process resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen process resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_product", "service": "keygen", "name": "update_product", "description": "Update a product in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen product resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen product resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.update_user", "service": "keygen", "name": "update_user", "description": "Update a user in the connected Keygen account.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen user resource ID." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API resource attributes to send to Keygen. Use the official attribute names for the target resource." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API relationships to send to Keygen. Use standard relationship linkage objects from the Keygen API docs." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API meta fields to send to Keygen for this resource or action." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for updating a Keygen user resource." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.validate_license_by_id", "service": "keygen", "name": "validate_license_by_id", "description": "Validate a Keygen license by its resource ID and optional validation scope.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Keygen license resource ID to validate." }, "nonce": { "type": "integer", "description": "An optional numerical nonce echoed by Keygen in signed responses." }, "scope": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Optional Keygen validation scope, such as fingerprint, product, policy, machine, or user scope." } }, "additionalProperties": false, "required": [ "id" ], "description": "Input parameters for validating a Keygen license by ID." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.validate_license_key", "service": "keygen", "name": "validate_license_key", "description": "Validate a Keygen license key and optional validation scope.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "description": "The Keygen license key to validate." }, "nonce": { "type": "integer", "description": "An optional numerical nonce echoed by Keygen in signed responses." }, "scope": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Optional Keygen validation scope, such as fingerprint, product, policy, machine, or user scope." } }, "additionalProperties": false, "required": [ "key" ], "description": "Input parameters for validating a Keygen license key." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } }, { "id": "keygen.whoami", "service": "keygen", "name": "whoami", "description": "Fetch the Keygen profile associated with the connected API token.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "Input parameters for fetching the current Keygen profile." }, "outputSchema": { "type": "object", "properties": { "data": { "description": "The JSON:API data member returned by Keygen." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API meta member returned by Keygen." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links member returned by Keygen." }, "included": { "type": "array", "items": { "description": "Included resource." }, "description": "Included JSON:API resources returned by Keygen." }, "errors": { "type": "array", "items": { "description": "Error object." }, "description": "JSON:API errors returned by Keygen." } }, "additionalProperties": true, "description": "The raw JSON:API document returned by Keygen." } } ] }