Keygen

Keygen integration (Developer Tools, Security). Imported from open-connector.

API key66 toolshttps://api.keygen.sh/v1/accounts

GET

keygen_whoami

Fetch the Keygen profile associated with the connected API token.

GET

keygen_list_products

List products in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_product

Retrieve one product from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen product resource ID.

POST

keygen_create_product

Create a product in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_product

Delete a product from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen product resource ID.

GET

keygen_list_entitlements

List entitlements in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_entitlement

Retrieve one entitlement from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen entitlement resource ID.

POST

keygen_create_entitlement

Create an entitlement in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_entitlement

Delete an entitlement from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen entitlement resource ID.

GET

keygen_list_groups

List groups in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_group

Retrieve one group from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen group resource ID.

POST

keygen_create_group

Create a group in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_group

Delete a group from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen group resource ID.

GET

keygen_list_policies

List license policies in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_policy

Retrieve one license policy from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen policy resource ID.

POST

keygen_create_policy

Create a license policy in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_policy

Delete a license policy from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen policy resource ID.

GET

keygen_list_policy_entitlements

List entitlements attached to a Keygen policy.

4 parameters

Param	Type	Required	Description
id	string	required	The parent Keygen resource ID.
limit	integer	optional	The maximum number of related resources to return from Keygen.
pageSize	integer	optional	The Keygen cursor page size to request.
pageCursor	string	optional	The Keygen cursor value for the page to return.

POST

keygen_attach_policy_entitlements

Attach entitlements to a Keygen policy.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
entitlementIds	array	optional	The Keygen entitlement IDs to attach to the policy.

DELETE

keygen_detach_policy_entitlements

Detach entitlements from a Keygen policy.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
entitlementIds	array	optional	The Keygen entitlement IDs to detach from the policy.

GET

keygen_list_users

List users in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_user

Retrieve one user from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen user resource ID.

POST

keygen_create_user

Create a user in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_user

Delete a user from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen user resource ID.

POST

keygen_ban_user

Ban a Keygen user from authenticating.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen user resource ID.

POST

keygen_unban_user

Unban a Keygen user so they can authenticate again.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen user resource ID.

PUT

keygen_change_user_group

Move a Keygen user to another group.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
groupId	string	optional	The Keygen group ID to assign to the user.

GET

keygen_list_licenses

List licenses in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_license

Retrieve one license from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

POST

keygen_create_license

Create a license in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_license

Delete a license from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

POST

keygen_suspend_license

Suspend a Keygen license so it can no longer authenticate with the API.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

POST

keygen_reinstate_license

Reinstate a suspended Keygen license.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

POST

keygen_renew_license

Renew a Keygen license according to its policy.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

DELETE

keygen_revoke_license

Revoke a Keygen license through the official revoke action.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

POST

keygen_check_in_license

Check in a Keygen license for policies that require periodic license check-ins.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

POST

keygen_increment_license_usage

Increment metered usage for a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	required	The Keygen license resource ID.
increment	integer	optional	The usage amount to increment. Keygen defaults to 1 when omitted.

POST

keygen_decrement_license_usage

Decrement metered usage for a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	required	The Keygen license resource ID.
decrement	integer	optional	The usage amount to decrement. Keygen defaults to 1 when omitted.

POST

keygen_reset_license_usage

Reset metered usage for a Keygen license.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen license resource ID.

POST

keygen_validate_license_key

Validate a Keygen license key and optional validation scope.

3 parameters

Param	Type	Required	Description
key	string	required	The Keygen license key to validate.
nonce	integer	optional	An optional numerical nonce echoed by Keygen in signed responses.
scope	object	optional	Optional Keygen validation scope, such as fingerprint, product, policy, machine…

GET

keygen_list_license_users

List users attached to a Keygen license.

4 parameters

Param	Type	Required	Description
id	string	required	The parent Keygen resource ID.
limit	integer	optional	The maximum number of related resources to return from Keygen.
pageSize	integer	optional	The Keygen cursor page size to request.
pageCursor	string	optional	The Keygen cursor value for the page to return.

POST

keygen_attach_license_users

Attach users to a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
userIds	array	optional	The Keygen user IDs to attach to the license.

DELETE

keygen_detach_license_users

Detach users from a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
userIds	array	optional	The Keygen user IDs to detach from the license.

GET

keygen_list_license_entitlements

List entitlements attached to a Keygen license.

4 parameters

Param	Type	Required	Description
id	string	required	The parent Keygen resource ID.
limit	integer	optional	The maximum number of related resources to return from Keygen.
pageSize	integer	optional	The Keygen cursor page size to request.
pageCursor	string	optional	The Keygen cursor value for the page to return.

POST

keygen_attach_license_entitlements

Attach entitlements to a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
entitlementIds	array	optional	The Keygen entitlement IDs to attach to the license.

DELETE

keygen_detach_license_entitlements

Detach entitlements from a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
entitlementIds	array	optional	The Keygen entitlement IDs to detach from the license.

PUT

keygen_change_license_policy

Move a Keygen license to another policy.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
policyId	string	optional	The Keygen policy ID to assign to the license.

PUT

keygen_change_license_owner

Change the owner user for a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
userId	string	optional	The Keygen user ID to assign as the license owner.

PUT

keygen_change_license_group

Change the group assigned to a Keygen license.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
groupId	string	optional	The Keygen group ID to assign to the license.

GET

keygen_list_machines

List activated machines in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_machine

Retrieve one activated machine from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen machine resource ID.

POST

keygen_activate_machine

Activate a machine in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_deactivate_machine

Deactivate a machine from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen machine resource ID.

POST

keygen_ping_machine

Ping a Keygen machine heartbeat.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen machine resource ID.

POST

keygen_reset_machine_heartbeat

Reset a Keygen machine heartbeat.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen machine resource ID.

PUT

keygen_change_machine_owner

Change the owner user for a Keygen machine.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
userId	string	optional	The Keygen user ID to assign as the machine owner.

PUT

keygen_change_machine_group

Change the group assigned to a Keygen machine.

2 parameters

Param	Type	Required	Description
id	string	optional	The parent Keygen resource ID.
groupId	string	optional	The Keygen group ID to assign to the machine.

GET

keygen_list_components

List machine components in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_component

Retrieve one machine component from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen component resource ID.

POST

keygen_create_component

Create a machine component in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_component

Delete a machine component from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen component resource ID.

GET

keygen_list_processes

List tracked processes in the connected Keygen account.

4 parameters

Param	Type	Required	Description
pageNumber	integer	optional	The page number to return from Keygen.
pageSize	integer	optional	The number of resources to request from Keygen.
include	string	optional	Comma-separated Keygen relationship names to include in the response.
filter	object	optional	Keygen JSON:API filters keyed by filter name. Values are serialized as filter[k…

GET

keygen_retrieve_process

Retrieve one tracked process from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen process resource ID.

POST

keygen_create_process

Create a tracked process in the connected Keygen account.

3 parameters

Param	Type	Required	Description
attributes	object	required	JSON:API resource attributes to send to Keygen. Use the official attribute name…
relationships	object	optional	JSON:API relationships to send to Keygen. Use standard relationship linkage obj…
meta	object	optional	JSON:API meta fields to send to Keygen for this resource or action.

DELETE

keygen_delete_process

Delete a tracked process from the connected Keygen account.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen process resource ID.

POST

keygen_ping_process

Ping a Keygen process heartbeat.

1 parameter

Param	Type	Required	Description
id	string	optional	The Keygen process resource ID.