> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Twingate

> How to set up the Twingate connector, plus the actions and events that are available.

![Twingate](https://stackone-logos.com/api/twingate/filled/svg)

Previewv0.2.0[See changelog](https://docs.stackone.com/connectors/twingate/changelog.md)

[89 actions](#actions) · [15 events](#events) · 1 auth method

Security
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/twingate/guides/connector-profile/api-key.md)
>
> No app registration required. Uses one network's API token, whose permission level decides which actions work.

Optionally, configure receiving Events for Twingate into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/twingate/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/twingate/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

provision

read

read\_write

No scopes found

89 actions

ActionDescriptionRequired scopes

List Access Requests`twingate_list_access_requests`

List requests from users for access to Twingate Resources.

`read`

Get Access Request`twingate_get_access_request`

Get one Twingate access request by ID.

`read`

Approve Access Request`twingate_approve_access_request`

Approve a pending Twingate access request.

`read_write`

Reject Access Request`twingate_reject_access_request`

Reject a pending Twingate access request.

`read_write`

List Certificate Authorities`twingate_list_certificate_authorities`

List the X.509 and SSH certificate authorities of a Twingate network.

`read`

Get Certificate Authority`twingate_get_certificate_authority`

Get one Twingate certificate authority by ID.

`read`

Create SSH Certificate Authority`twingate_create_ssh_certificate_authority`

Register an SSH certificate authority in Twingate.

`read_write`

Delete SSH Certificate Authority`twingate_delete_ssh_certificate_authority`

Delete a Twingate SSH certificate authority.

`read_write`

Create X.509 Certificate Authority`twingate_create_x509_certificate_authority`

Register an X.509 certificate authority in Twingate.

`read_write`

Delete X.509 Certificate Authority`twingate_delete_x509_certificate_authority`

Delete a Twingate X.509 certificate authority.

`read_write`

List Connectors`twingate_list_connectors`

List the Connectors of a Twingate network.

`read`

Get Connector`twingate_get_connector`

Get one Twingate Connector by ID.

`read`

Create Connector`twingate_create_connector`

Register a new Connector in a Twingate Remote Network.

`read_write`

Update Connector`twingate_update_connector`

Rename a Twingate Connector or change its status notifications.

`read_write`

Delete Connector`twingate_delete_connector`

Delete a Twingate Connector.

`read_write`

Generate Connector Tokens`twingate_generate_connector_tokens`

Generate the tokens used to deploy a Twingate Connector.

`provision`

List Devices`twingate_list_devices`

List the devices that have signed in to a Twingate network.

`read`

Get Device`twingate_get_device`

Get one Twingate device by ID.

`read`

Update Device`twingate_update_device`

Manually trust or untrust a Twingate device.

`read_write`

Block Device`twingate_block_device`

Block a Twingate device from connecting.

`read_write`

Unblock Device`twingate_unblock_device`

Unblock a blocked Twingate device.

`read_write`

Archive Device`twingate_archive_device`

Archive a Twingate device.

`read_write`

Unarchive Device`twingate_unarchive_device`

Restore an archived Twingate device.

`read_write`

Get Device Posture`twingate_get_device_posture`

Get the security posture checks of a Twingate device.

`read`

List DNS Filtering Profiles`twingate_list_dns_filtering_profiles`

List the DNS filtering profiles of a Twingate network.

`read`

Get DNS Filtering Profile`twingate_get_dns_filtering_profile`

Get one Twingate DNS filtering profile by ID.

`read`

Create DNS Filtering Profile`twingate_create_dns_filtering_profile`

Create a DNS filtering profile in Twingate.

`read_write`

Update DNS Filtering Profile`twingate_update_dns_filtering_profile`

Change the domains, categories, groups or priority of a Twingate DNS filtering profile.

`read_write`

Delete DNS Filtering Profile`twingate_delete_dns_filtering_profile`

Delete a Twingate DNS filtering profile.

`read_write`

List Gateways`twingate_list_gateways`

List the Gateways of a Twingate network.

`read`

Get Gateway`twingate_get_gateway`

Get one Twingate Gateway by ID.

`read`

Create Gateway`twingate_create_gateway`

Create a Twingate Gateway for SSH, Kubernetes or web app Resources.

`read_write`

Update Gateway`twingate_update_gateway`

Change the address, Remote Network or certificate authorities of a Twingate Gateway.

`read_write`

Delete Gateway`twingate_delete_gateway`

Delete a Twingate Gateway.

`read_write`

List Groups`twingate_list_groups`

List the groups of a Twingate network.

`read`

Get Group`twingate_get_group`

Get one Twingate group by ID.

`read`

Create Group`twingate_create_group`

Create a manual group in a Twingate network.

`read_write`

Update Group`twingate_update_group`

Rename a Twingate group or add and remove its users and Resources.

`read_write`

Delete Group`twingate_delete_group`

Delete a Twingate group.

`read_write`

List Unified Groups`twingate_unified_list_groups`

List unified groups in a Twingate network.

`read`

Get Unified Group`twingate_unified_get_group`

Get a unified Twingate group by ID.

`read`

List Unified Roles`twingate_unified_list_roles`

List the Admin Console roles of Twingate.

`read`

Get Unified Role`twingate_unified_get_role`

Get a unified Twingate role by ID.

`read`

List Unified Users`twingate_unified_list_users`

List unified users in a Twingate network.

`read`

Get Unified User`twingate_unified_get_user`

Get a unified Twingate user by ID.

`read`

List Remote Networks`twingate_list_remote_networks`

List the Remote Networks of a Twingate network.

`read`

Get Remote Network`twingate_get_remote_network`

Get one Twingate Remote Network by ID or exact name.

`read`

Create Remote Network`twingate_create_remote_network`

Create a Remote Network in Twingate.

`read_write`

Update Remote Network`twingate_update_remote_network`

Rename, relocate, enable or disable a Twingate Remote Network.

`read_write`

Delete Remote Network`twingate_delete_remote_network`

Delete a Twingate Remote Network.

`read_write`

List Resources`twingate_list_resources`

List the Resources of a Twingate network.

`read`

Get Resource`twingate_get_resource`

Get one Twingate Resource by ID.

`read`

Create Resource`twingate_create_resource`

Create a network Resource in Twingate.

`read_write`

Update Resource`twingate_update_resource`

Change the settings of a Twingate network Resource.

`read_write`

Delete Resource`twingate_delete_resource`

Delete a Twingate Resource.

`read_write`

Get Resource Access`twingate_get_resource_access`

List the groups and service accounts that can reach a Twingate Resource.

`read`

Add Resource Access`twingate_add_resource_access`

Grant groups or service accounts access to a Twingate Resource.

`read_write`

Remove Resource Access`twingate_remove_resource_access`

Remove groups or service accounts from the access list of a Twingate Resource.

`read_write`

Set Resource Access`twingate_set_resource_access`

Replace the full access list of a Twingate Resource.

`read_write`

Create Kubernetes Resource`twingate_create_kubernetes_resource`

Create a Kubernetes cluster Resource reached through a Twingate Gateway.

`read_write`

Update Kubernetes Resource`twingate_update_kubernetes_resource`

Change the settings of a Twingate Kubernetes Resource.

`read_write`

Create SSH Resource`twingate_create_ssh_resource`

Create an SSH server Resource reached through a Twingate Gateway.

`read_write`

Update SSH Resource`twingate_update_ssh_resource`

Change the settings of a Twingate SSH Resource.

`read_write`

Create Web App Resource`twingate_create_web_app_resource`

Create a web application Resource reached through a Twingate Gateway.

`read_write`

Update Web App Resource`twingate_update_web_app_resource`

Change the settings of a Twingate web app Resource.

`read_write`

List Security Policies`twingate_list_security_policies`

List the security policies of a Twingate network.

`read`

Get Security Policy`twingate_get_security_policy`

Get one Twingate security policy by ID or exact name.

`read`

Update Security Policy`twingate_update_security_policy`

Change which groups a Twingate security policy applies to.

`read_write`

List Serial Numbers`twingate_list_serial_numbers`

List the trusted device serial numbers of a Twingate network.

`read`

Create Serial Numbers`twingate_create_serial_numbers`

Add device serial numbers to the Twingate trusted list.

`read_write`

Delete Serial Numbers`twingate_delete_serial_numbers`

Remove device serial numbers from the Twingate trusted list.

`read_write`

Get Service Account Key`twingate_get_service_account_key`

Get one Twingate service account key by ID or exact name.

`read`

Create Service Account Key`twingate_create_service_account_key`

Issue a new key for a Twingate service account.

`provision`

Update Service Account Key`twingate_update_service_account_key`

Rename a Twingate service account key.

`read_write`

Revoke Service Account Key`twingate_revoke_service_account_key`

Revoke a Twingate service account key.

`read_write`

Delete Service Account Key`twingate_delete_service_account_key`

Delete a Twingate service account key.

`read_write`

List Service Accounts`twingate_list_service_accounts`

List the service accounts of a Twingate network.

`read`

Get Service Account`twingate_get_service_account`

Get one Twingate service account by ID.

`read`

Create Service Account`twingate_create_service_account`

Create a Twingate service account.

`read_write`

Update Service Account`twingate_update_service_account`

Rename a Twingate service account or change its Resources.

`read_write`

Delete Service Account`twingate_delete_service_account`

Delete a Twingate service account.

`read_write`

Get Events Sync OIDC Provider URL`twingate_get_events_sync_oidc_provider_url`

Get the OIDC provider URL used to sync Twingate network events to Amazon S3.

`read`

List Users`twingate_list_users`

List the users of a Twingate network.

`read`

Get User`twingate_get_user`

Get one Twingate user by ID.

`read`

Create User`twingate_create_user`

Add a user to a Twingate network.

`read_write`

Update User Details`twingate_update_user_details`

Change the name or state of a Twingate user.

`read_write`

Update User Role`twingate_update_user_role`

Change the Admin Console role of a Twingate user.

`read_write`

Delete User`twingate_delete_user`

Delete a Twingate user.

`read_write`

Reset User MFA`twingate_reset_user_mfa`

Reset the Twingate multi-factor authentication of a user.

`read_write`

## Events

Tags

Select all
|
Clear

Access Requests

Clients

Connectors

Device Integrations

Events Sync

Integrations

Service Accounts

No tags found

15 events

EventDescriptionTags

Access Request`twingate_webhook_access_request`

Processes Twingate access request notifications.

Access Requests

Service Account Keys Expiring`twingate_webhook_service_account_keys_expiration`

Processes Twingate notifications about service account keys that expire soon.

Service Accounts

Device Integration Token Expiring`twingate_webhook_device_integration_api_token_expiration`

Processes Twingate notifications about an expiring device integration API token.

Device Integrations

Connectors Offline`twingate_webhook_connector_status_offline`

Processes Twingate notifications that Connectors went offline.

Connectors

Connectors Online`twingate_webhook_connector_status_online`

Processes Twingate notifications that Connectors came back online.

Connectors

Connector Upgrade Available`twingate_webhook_connector_upgrade_available`

Processes Twingate notifications that Connectors have a newer version.

Connectors

Client Update Recommended`twingate_webhook_client_update_recommended`

Processes Twingate notifications that a Client update is recommended.

Clients

Client Update Required`twingate_webhook_client_update_required`

Processes Twingate notifications that a Client update is required.

Clients

Integration Errors`twingate_webhook_integration_errors`

Processes Twingate notifications that an integration is failing.

Integrations

Integration Error Resolved`twingate_webhook_integration_error_resolved`

Processes Twingate notifications that an integration error was resolved.

Integrations

Identity Provider Error`twingate_webhook_identity_provider_integration_error`

Processes Twingate notifications about an identity provider integration error.

Integrations

Google Workspace Sync Error`twingate_webhook_google_workspace_sync_error`

Processes Twingate notifications that Google Workspace sync failed.

Integrations

Events Sync Errors`twingate_webhook_events_sync_errors`

Processes Twingate notifications that network event sync is failing.

Events Sync

Events Sync Error Resolved`twingate_webhook_events_sync_error_resolved`

Processes Twingate notifications that network event sync errors were resolved.

Events Sync

Events Sync Requires Attention`twingate_webhook_events_sync_requires_attention`

Processes Twingate notifications that network event sync needs attention.

Events Sync


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.