Twingate GraphQL API Reference

Welcome to the Twingate GraphQL API reference. This reference includes the the complete GraphQL schema for Twingate’s API. Learn how to start using the API by reading our getting started with the API guide.

Contact

Twingate Support

https://www.twingate.com/support

Terms of Service

https://www.twingate.com/terms

API Endpoints

https://<network name>.twingate.com/api/graphql/

Headers

# Your API token from the admin console. Must be included in all API calls.
X-API-KEY: <YOUR_TOKEN_HERE>

Queries

accessRequest

Description

Fetches a single Access Request by its ID.

Response

Returns an AccessRequest

Arguments

Example

Query

query accessRequest($id: ID!) {
  accessRequest(id: $id) {
    reason
    requestedAt
    id
    user {
      ...UserFragment
    }
    resource {
      ...ResourceFragment
    }
    status
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "accessRequest": {
      "reason": "example",
      "requestedAt": "2024-01-01T00:00:00.000Z",
      "id": "YWJjMTIzeHl6Nzg5",
      "user": User,
      "resource": Resource,
      "status": "PENDING"
    }
  }
}

Queries

accessRequests

Description

Fetches a list of Access Requests.

Response

Returns an AccessRequestConnection!

Arguments

Example

Query

query accessRequests(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: AccessRequestFilterInput
) {
  accessRequests(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...AccessRequestEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": AccessRequestFilterInput
}

Response

{
  "data": {
    "accessRequests": {
      "pageInfo": PageInfo,
      "edges": [AccessRequestEdge],
      "totalCount": 10
    }
  }
}

Queries

certificateAuthorities

Description

Fetches a list of Certificate Authorities.

Response

Returns a CertificateAuthorityConnection!

Arguments

Example

Query

query certificateAuthorities(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  certificateAuthorities(
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CertificateAuthorityEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1
}

Response

{
  "data": {
    "certificateAuthorities": {
      "pageInfo": PageInfo,
      "edges": [CertificateAuthorityEdge],
      "totalCount": 10
    }
  }
}

Queries

certificateAuthority

Description

Fetches a Certificate Authority by its ID.

Response

Returns a CertificateAuthority

Arguments

Example

Query

query certificateAuthority($id: ID!) {
  certificateAuthority(id: $id) {
    ... on X509CertificateAuthority {
      ...X509CertificateAuthorityFragment
    }
    ... on SSHCertificateAuthority {
      ...SSHCertificateAuthorityFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "certificateAuthority": X509CertificateAuthority
  }
}

Queries

connector

Description

Fetches a single Connector by its ID.

Response

Returns a Connector

Arguments

Example

Query

query connector($id: ID!) {
  connector(id: $id) {
    createdAt
    updatedAt
    lastHeartbeatAt
    hostname
    id
    name
    remoteNetwork {
      ...RemoteNetworkFragment
    }
    state
    hasStatusNotificationsEnabled
    version
    publicIP
    privateIPs
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "connector": {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "lastHeartbeatAt": "2024-01-01T00:00:00.000Z",
      "hostname": "server.example.com",
      "id": "YWJjMTIzeHl6Nzg5",
      "name": "Example Name",
      "remoteNetwork": RemoteNetwork,
      "state": "ALIVE",
      "hasStatusNotificationsEnabled": true,
      "version": "1.0.0",
      "publicIP": "192.168.1.1",
      "privateIPs": ["192.168.1.1"]
    }
  }
}

Queries

connectors

Description

Fetches a list of Connectors.

Response

Returns a ConnectorConnection!

Arguments

Example

Query

query connectors(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: ConnectorFilterInput
) {
  connectors(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ConnectorEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": ConnectorFilterInput
}

Response

{
  "data": {
    "connectors": {
      "pageInfo": PageInfo,
      "edges": [ConnectorEdge],
      "totalCount": 10
    }
  }
}

Queries

device

Description

Look up a Device by its ID.

Response

Returns a Device

Arguments

Example

Query

query device($id: ID!) {
  device(id: $id) {
    id
    name
    lastFailedLoginAt
    osVersion
    hardwareModel
    hostname
    username
    serialNumber
    user {
      ...UserFragment
    }
    lastConnectedAt
    osName
    deviceType
    activeState
    lastSuccessfulLoginAt
    isTrusted
    clientVersion
    manufacturerName
    internetSecurityConfiguration
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "device": {
      "id": "YWJjMTIzeHl6Nzg5",
      "name": "Example Name",
      "lastFailedLoginAt": "2024-01-01T00:00:00.000Z",
      "osVersion": "1.0.0",
      "hardwareModel": "example",
      "hostname": "server.example.com",
      "username": "johndoe",
      "serialNumber": "example",
      "user": User,
      "lastConnectedAt": "2024-01-01T00:00:00.000Z",
      "osName": "IPADOS",
      "deviceType": "GENERIC",
      "activeState": "ACTIVE",
      "lastSuccessfulLoginAt": "2024-01-01T00:00:00.000Z",
      "isTrusted": true,
      "clientVersion": "1.0.0",
      "manufacturerName": "example",
      "internetSecurityConfiguration": "example"
    }
  }
}

Queries

devicePosture

Description

Fetches the posture status of a Device by its ID.

Response

Returns a DevicePosture!

Arguments

Example

Query

query devicePosture($id: ID!) {
  devicePosture(id: $id) {
    hardDriveEncryption {
      ...DevicePropertyPostureCheckFragment
    }
    screenLockPasscode {
      ...DevicePropertyPostureCheckFragment
    }
    firewall {
      ...DevicePropertyPostureCheckFragment
    }
    biometric {
      ...DevicePropertyPostureCheckFragment
    }
    antivirus {
      ...DevicePropertyPostureCheckFragment
    }
    osVersion {
      ...OsVersionPostureCheckFragment
    }
    crowdstrike {
      ...TrustProviderVerificationFragment
    }
    jamf {
      ...TrustProviderVerificationFragment
    }
    kandji {
      ...TrustProviderVerificationFragment
    }
    iru {
      ...TrustProviderVerificationFragment
    }
    inTune {
      ...TrustProviderVerificationFragment
    }
    sentinelOne {
      ...TrustProviderVerificationFragment
    }
    onePassword {
      ...TrustProviderVerificationFragment
    }
    manualVerification {
      ...ManualVerificationFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "devicePosture": {
      "hardDriveEncryption": DevicePropertyPostureCheck,
      "screenLockPasscode": DevicePropertyPostureCheck,
      "firewall": DevicePropertyPostureCheck,
      "biometric": DevicePropertyPostureCheck,
      "antivirus": DevicePropertyPostureCheck,
      "osVersion": OsVersionPostureCheck,
      "crowdstrike": TrustProviderVerification,
      "jamf": TrustProviderVerification,
      "kandji": TrustProviderVerification,
      "iru": TrustProviderVerification,
      "inTune": TrustProviderVerification,
      "sentinelOne": TrustProviderVerification,
      "onePassword": TrustProviderVerification,
      "manualVerification": ManualVerification
    }
  }
}

Queries

devices

Description

Fetches a list of Devices.

Response

Returns a DeviceConnection!

Arguments

Example

Query

query devices(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: DeviceFilterInput
) {
  devices(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...DeviceEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": DeviceFilterInput
}

Response

{
  "data": {
    "devices": {
      "pageInfo": PageInfo,
      "edges": [DeviceEdge],
      "totalCount": 10
    }
  }
}

Queries

dnsFilteringProfile

Description

Return a DNS filtering profile. None is returned when DNS filtering is not enabled.

Response

Returns a DnsFilteringProfile

Arguments

Example

Query

query dnsFilteringProfile($id: ID!) {
  dnsFilteringProfile(id: $id) {
    name
    id
    priority
    fallbackMethod
    groups {
      ...GroupConnectionFragment
    }
    allowedDomains
    deniedDomains
    contentCategoryConfig {
      ...ContentCategoryConfigFragment
    }
    securityCategoryConfig {
      ...SecurityCategoryConfigFragment
    }
    privacyCategoryConfig {
      ...PrivacyCategoryConfigFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "dnsFilteringProfile": {
      "name": "Example Name",
      "id": "YWJjMTIzeHl6Nzg5",
      "priority": 123.45,
      "fallbackMethod": "AUTO",
      "groups": GroupConnection,
      "allowedDomains": ["example.com"],
      "deniedDomains": ["example.com"],
      "contentCategoryConfig": ContentCategoryConfig,
      "securityCategoryConfig": SecurityCategoryConfig,
      "privacyCategoryConfig": PrivacyCategoryConfig
    }
  }
}

Queries

dnsFilteringProfiles

Description

Return a list of DNS filtering profiles Metadata. None is returned when DNS filtering is not enabled.

Response

Returns [DnsFilteringProfileMetadata!]

Example

Query

query dnsFilteringProfiles {
  dnsFilteringProfiles {
    name
    id
    priority
  }
}

Response

{
  "data": {
    "dnsFilteringProfiles": [\
      {"name": "Example Name", "id": "YWJjMTIzeHl6Nzg5", "priority": 123.45}\
    ]
  }
}

Queries

eventsSyncOidcProviderUrl

Description

The OIDC Identity Provider URL to register in Cloud provider for the current tenant.

Response

Returns a String!

Example

Query

query eventsSyncOidcProviderUrl {
  eventsSyncOidcProviderUrl
}

Response

{
  "data": {
    "eventsSyncOidcProviderUrl": "example"
  }
}

Queries

gateway

Description

Fetches a Gateway by its ID.

Response

Returns a Gateway

Arguments

Example

Query

query gateway($id: ID!) {
  gateway(id: $id) {
    address
    id
    remoteNetwork {
      ...RemoteNetworkFragment
    }
    x509CA {
      ...X509CertificateAuthorityFragment
    }
    sshCA {
      ...SSHCertificateAuthorityFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "gateway": {
      "address": "192.168.1.100",
      "id": "YWJjMTIzeHl6Nzg5",
      "remoteNetwork": RemoteNetwork,
      "x509CA": X509CertificateAuthority,
      "sshCA": SSHCertificateAuthority
    }
  }
}

Queries

gateways

Description

Fetches a list of Gateways.

Response

Returns a GatewayConnection!

Arguments

Example

Query

query gateways(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  gateways(
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...GatewayEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1
}

Response

{
  "data": {
    "gateways": {
      "pageInfo": PageInfo,
      "edges": [GatewayEdge],
      "totalCount": 10
    }
  }
}

Queries

group

Description

Fetches a Group by its ID.

Response

Returns a Group

Arguments

Example

Query

query group($id: ID!) {
  group(id: $id) {
    id
    createdAt
    updatedAt
    name
    originId
    isActive
    type
    users {
      ...UserConnectionFragment
    }
    resources {
      ...ResourceConnectionFragment
    }
    securityPolicy {
      ...SecurityPolicyFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "group": {
      "id": "YWJjMTIzeHl6Nzg5",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "name": "Example Name",
      "originId": "example",
      "isActive": true,
      "type": "MANUAL",
      "users": UserConnection,
      "resources": ResourceConnection,
      "securityPolicy": SecurityPolicy
    }
  }
}

Queries

groups

Description

Fetches a list of Groups.

Response

Returns a GroupConnection!

Arguments

Example

Query

query groups(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: GroupFilterInput
) {
  groups(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...GroupEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": GroupFilterInput
}

Response

{
  "data": {
    "groups": {
      "pageInfo": PageInfo,
      "edges": [GroupEdge],
      "totalCount": 10
    }
  }
}

Queries

remoteNetwork

Description

Fetches a single Remote Network by ID or name.

Response

Returns a RemoteNetwork

Arguments

Example

Query

query remoteNetwork(
  $id: ID,
  $name: String
) {
  remoteNetwork(
    id: $id,
    name: $name
  ) {
    createdAt
    updatedAt
    name
    id
    networkType
    location
    isActive
    resources {
      ...ResourceConnectionFragment
    }
    connectors {
      ...ConnectorConnectionFragment
    }
    gateways {
      ...GatewayConnectionFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5", "name": "Example Name"}

Response

{
  "data": {
    "remoteNetwork": {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "name": "Example Name",
      "id": "YWJjMTIzeHl6Nzg5",
      "networkType": "REGULAR",
      "location": "AWS",
      "isActive": true,
      "resources": ResourceConnection,
      "connectors": ConnectorConnection,
      "gateways": GatewayConnection
    }
  }
}

Queries

remoteNetworks

Description

Fetches a list of Remote Networks.

Response

Returns a RemoteNetworkConnection!

Arguments

Example

Query

query remoteNetworks(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: RemoteNetworkFilterInput
) {
  remoteNetworks(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...RemoteNetworkEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": RemoteNetworkFilterInput
}

Response

{
  "data": {
    "remoteNetworks": {
      "pageInfo": PageInfo,
      "edges": [RemoteNetworkEdge],
      "totalCount": 10
    }
  }
}

Queries

resource

Description

Fetch a single Resource by its ID.

Response

Returns a Resource

Arguments

Example

Query

query resource($id: ID!) {
  resource(id: $id) {
    id
    createdAt
    updatedAt
    name
    tags {
      ...TagFragment
    }
    address {
      ...ResourceAddressFragment
    }
    alias
    protocols {
      ...ResourceProtocolsFragment
    }
    isActive
    remoteNetwork {
      ...RemoteNetworkFragment
    }
    groups {
      ...GroupConnectionFragment
    }
    serviceAccounts {
      ...ServiceAccountConnectionFragment
    }
    access {
      ...AccessConnectionFragment
    }
    isVisible
    isBrowserShortcutEnabled
    securityPolicy {
      ...SecurityPolicyFragment
    }
    usageBasedAutolockDurationDays
    accessPolicy {
      ...AccessPolicyFragment
    }
    approvalMode
    approverGroups {
      ...GroupConnectionFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "resource": {
      "id": "YWJjMTIzeHl6Nzg5",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "name": "Example Name",
      "tags": [Tag],
      "address": ResourceAddress,
      "alias": "example",
      "protocols": ResourceProtocols,
      "isActive": true,
      "remoteNetwork": RemoteNetwork,
      "groups": GroupConnection,
      "serviceAccounts": ServiceAccountConnection,
      "access": AccessConnection,
      "isVisible": true,
      "isBrowserShortcutEnabled": true,
      "securityPolicy": SecurityPolicy,
      "usageBasedAutolockDurationDays": 12345,
      "accessPolicy": AccessPolicy,
      "approvalMode": "MANUAL",
      "approverGroups": GroupConnection
    }
  }
}

Queries

resources

Description

Fetches a list of Resources.

Response

Returns a ResourceConnection!

Arguments

Example

Query

query resources(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: ResourceFilterInput
) {
  resources(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ResourceEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": ResourceFilterInput
}

Response

{
  "data": {
    "resources": {
      "pageInfo": PageInfo,
      "edges": [ResourceEdge],
      "totalCount": 10
    }
  }
}

Queries

securityPolicies

Description

Fetches a list of Security Policies.

Response

Returns a SecurityPolicyConnection!

Arguments

Example

Query

query securityPolicies(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: SecurityPolicyFilterField
) {
  securityPolicies(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...SecurityPolicyEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": SecurityPolicyFilterField
}

Response

{
  "data": {
    "securityPolicies": {
      "pageInfo": PageInfo,
      "edges": [SecurityPolicyEdge],
      "totalCount": 10
    }
  }
}

Queries

securityPolicy

Description

Fetches a single Security Policy by its ID or name.

Response

Returns a SecurityPolicy

Arguments

Example

Query

query securityPolicy(
  $id: ID,
  $name: String
) {
  securityPolicy(
    id: $id,
    name: $name
  ) {
    id
    createdAt
    updatedAt
    name
    policyType
    groups {
      ...GroupConnectionFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5", "name": "Example Name"}

Response

{
  "data": {
    "securityPolicy": {
      "id": "YWJjMTIzeHl6Nzg5",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "name": "Example Name",
      "policyType": "RESOURCE",
      "groups": GroupConnection
    }
  }
}

Queries

serialNumbers

Description

List of serial numbers

Response

Returns a SerialNumberConnection!

Arguments

Example

Query

query serialNumbers(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: SerialNumberFilterInput
) {
  serialNumbers(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...SerialNumberEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": SerialNumberFilterInput
}

Response

{
  "data": {
    "serialNumbers": {
      "pageInfo": PageInfo,
      "edges": [SerialNumberEdge],
      "totalCount": 10
    }
  }
}

Queries

serviceAccount

Description

Fetches a single Service Account by its ID.

Response

Returns a ServiceAccount

Arguments

Example

Query

query serviceAccount($id: ID!) {
  serviceAccount(id: $id) {
    id
    name
    createdAt
    updatedAt
    resources {
      ...ResourceConnectionFragment
    }
    keys {
      ...ServiceAccountKeyConnectionFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "serviceAccount": {
      "id": "YWJjMTIzeHl6Nzg5",
      "name": "Example Name",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "resources": ResourceConnection,
      "keys": ServiceAccountKeyConnection
    }
  }
}

Queries

serviceAccountKey

Description

Fetches a single Service Account Key by its ID.

Response

Returns a ServiceAccountKey

Arguments

Example

Query

query serviceAccountKey(
  $id: ID,
  $name: String
) {
  serviceAccountKey(
    id: $id,
    name: $name
  ) {
    createdAt
    id
    name
    expiresAt
    revokedAt
    updatedAt
    status
    serviceAccount {
      ...ServiceAccountFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5", "name": "Example Name"}

Response

{
  "data": {
    "serviceAccountKey": {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "id": "YWJjMTIzeHl6Nzg5",
      "name": "Example Name",
      "expiresAt": "2024-12-31T23:59:59.000Z",
      "revokedAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "status": "ACTIVE",
      "serviceAccount": ServiceAccount
    }
  }
}

Queries

serviceAccounts

Description

Fetches a list of Service Accounts.

Response

Returns a ServiceAccountConnection!

Arguments

Example

Query

query serviceAccounts(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: ServiceAccountFilterInput
) {
  serviceAccounts(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ServiceAccountEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": ServiceAccountFilterInput
}

Response

{
  "data": {
    "serviceAccounts": {
      "pageInfo": PageInfo,
      "edges": [ServiceAccountEdge],
      "totalCount": 10
    }
  }
}

Queries

user

Description

Fetches a single User by its ID.

Response

Returns a User

Arguments

Example

Query

query user($id: ID!) {
  user(id: $id) {
    id
    createdAt
    updatedAt
    firstName
    lastName
    email
    avatarUrl
    state
    isAdmin
    role
    type
    groups {
      ...GroupConnectionFragment
    }
    devices {
      ...DeviceConnectionFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "user": {
      "id": "YWJjMTIzeHl6Nzg5",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T00:00:00.000Z",
      "firstName": "John",
      "lastName": "Doe",
      "email": "user@example.com",
      "avatarUrl": "example",
      "state": "PENDING",
      "isAdmin": false,
      "role": "ADMIN",
      "type": "MANUAL",
      "groups": GroupConnection,
      "devices": DeviceConnection
    }
  }
}

Queries

users

Description

Fetches a list of Users.

Response

Returns a UserConnection!

Arguments

Example

Query

query users(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $filter: UserFilterInput
) {
  users(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    filter: $filter
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...UserEdgeFragment
    }
    totalCount
  }
}

Variables

{
  "before": "YXJyYXljb25uZWN0aW9uOjQ=",
  "after": "YXJyYXljb25uZWN0aW9uOjk=",
  "first": 20,
  "last": 1,
  "filter": UserFilterInput
}

Response

{
  "data": {
    "users": {
      "pageInfo": PageInfo,
      "edges": [UserEdge],
      "totalCount": 10
    }
  }
}

Mutations

accessRequestApprove

Response

Returns an AccessRequestApproveMutation!

Arguments

Example

Query

mutation accessRequestApprove($id: ID!) {
  accessRequestApprove(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"accessRequestApprove": {"ok": true, "error": "example"}}}

Mutations

accessRequestReject

Response

Returns an AccessRequestRejectMutation!

Arguments

Example

Query

mutation accessRequestReject($id: ID!) {
  accessRequestReject(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"accessRequestReject": {"ok": true, "error": "example"}}}

Mutations

connectorCreate

Response

Returns a ConnectorCreateMutation!

Arguments

Example

Query

mutation connectorCreate(
  $hasStatusNotificationsEnabled: Boolean,
  $name: String,
  $remoteNetworkId: ID!
) {
  connectorCreate(
    hasStatusNotificationsEnabled: $hasStatusNotificationsEnabled,
    name: $name,
    remoteNetworkId: $remoteNetworkId
  ) {
    ok
    error
    entity {
      ...ConnectorFragment
    }
  }
}

Variables

{
  "hasStatusNotificationsEnabled": true,
  "name": "Example Name",
  "remoteNetworkId": "TmV0d29yazox"
}

Response

{
  "data": {
    "connectorCreate": {
      "ok": true,
      "error": "example",
      "entity": Connector
    }
  }
}

Mutations

connectorDelete

Response

Returns a ConnectorDeleteMutation!

Arguments

Example

Query

mutation connectorDelete($id: ID!) {
  connectorDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"connectorDelete": {"ok": true, "error": "example"}}}

Mutations

connectorGenerateTokens

Response

Returns a ConnectorGenerateTokensMutation!

Arguments

Example

Query

mutation connectorGenerateTokens($connectorId: ID!) {
  connectorGenerateTokens(connectorId: $connectorId) {
    ok
    error
    connectorTokens {
      ...ConnectorTokensFragment
    }
  }
}

Variables

{"connectorId": "Q29ubmVjdG9yOjE"}

Response

{
  "data": {
    "connectorGenerateTokens": {
      "ok": true,
      "error": "example",
      "connectorTokens": ConnectorTokens
    }
  }
}

Mutations

connectorUpdate

Response

Returns a ConnectorUpdateMutation!

Arguments

Example

Query

mutation connectorUpdate(
  $hasStatusNotificationsEnabled: Boolean,
  $id: ID!,
  $name: String
) {
  connectorUpdate(
    hasStatusNotificationsEnabled: $hasStatusNotificationsEnabled,
    id: $id,
    name: $name
  ) {
    ok
    error
    entity {
      ...ConnectorFragment
    }
  }
}

Variables

{
  "hasStatusNotificationsEnabled": true,
  "id": "YWJjMTIzeHl6Nzg5",
  "name": "Example Name"
}

Response

{
  "data": {
    "connectorUpdate": {
      "ok": true,
      "error": "example",
      "entity": Connector
    }
  }
}

Mutations

deviceArchive

Response

Returns a DeviceArchiveMutation!

Arguments

Example

Query

mutation deviceArchive($id: ID!) {
  deviceArchive(id: $id) {
    ok
    error
    entity {
      ...DeviceFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "deviceArchive": {
      "ok": true,
      "error": "example",
      "entity": Device
    }
  }
}

Mutations

deviceBlock

Response

Returns a DeviceBlockMutation!

Arguments

Example

Query

mutation deviceBlock($id: ID!) {
  deviceBlock(id: $id) {
    ok
    error
    entity {
      ...DeviceFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "deviceBlock": {
      "ok": true,
      "error": "example",
      "entity": Device
    }
  }
}

Mutations

deviceUnarchive

Response

Returns a DeviceUnarchiveMutation!

Arguments

Example

Query

mutation deviceUnarchive($id: ID!) {
  deviceUnarchive(id: $id) {
    ok
    error
    entity {
      ...DeviceFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "deviceUnarchive": {
      "ok": true,
      "error": "example",
      "entity": Device
    }
  }
}

Mutations

deviceUnblock

Response

Returns a DeviceUnblockMutation!

Arguments

Example

Query

mutation deviceUnblock($id: ID!) {
  deviceUnblock(id: $id) {
    ok
    error
    entity {
      ...DeviceFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "deviceUnblock": {
      "ok": true,
      "error": "example",
      "entity": Device
    }
  }
}

Mutations

deviceUpdate

Response

Returns a DeviceUpdateMutation!

Arguments

Example

Query

mutation deviceUpdate(
  $id: ID!,
  $isTrusted: Boolean!
) {
  deviceUpdate(
    id: $id,
    isTrusted: $isTrusted
  ) {
    ok
    error
    entity {
      ...DeviceFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5", "isTrusted": true}

Response

{
  "data": {
    "deviceUpdate": {
      "ok": true,
      "error": "example",
      "entity": Device
    }
  }
}

Mutations

dnsFilteringProfileCreate

Response

Returns a DnsFilteringProfileCreateMutation!

Arguments

Example

Query

mutation dnsFilteringProfileCreate($name: String!) {
  dnsFilteringProfileCreate(name: $name) {
    ok
    error
    entity {
      ...DnsFilteringProfileFragment
    }
  }
}

Variables

{"name": "Example Name"}

Response

{
  "data": {
    "dnsFilteringProfileCreate": {
      "ok": true,
      "error": "example",
      "entity": DnsFilteringProfile
    }
  }
}

Mutations

dnsFilteringProfileDelete

Response

Returns a DnsFilteringProfileDeleteMutation!

Arguments

Example

Query

mutation dnsFilteringProfileDelete($id: ID!) {
  dnsFilteringProfileDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"dnsFilteringProfileDelete": {"ok": true, "error": "example"}}}

Mutations

dnsFilteringProfileUpdate

Response

Returns a DnsFilteringProfileUpdateMutation!

Arguments

Example

Query

mutation dnsFilteringProfileUpdate(
  $allowedDomains: [String!],
  $contentCategoryConfig: ContentCategoryConfigInput,
  $deniedDomains: [String!],
  $fallbackMethod: DohFallbackMethod,
  $groups: [String!],
  $id: ID!,
  $name: String,
  $priority: Float,
  $privacyCategoryConfig: PrivacyCategoryConfigInput,
  $securityCategoryConfig: SecurityCategoryConfigInput
) {
  dnsFilteringProfileUpdate(
    allowedDomains: $allowedDomains,
    contentCategoryConfig: $contentCategoryConfig,
    deniedDomains: $deniedDomains,
    fallbackMethod: $fallbackMethod,
    groups: $groups,
    id: $id,
    name: $name,
    priority: $priority,
    privacyCategoryConfig: $privacyCategoryConfig,
    securityCategoryConfig: $securityCategoryConfig
  ) {
    ok
    error
    entity {
      ...DnsFilteringProfileFragment
    }
  }
}

Variables

{
  "allowedDomains": ["example.com"],
  "contentCategoryConfig": ContentCategoryConfigInput,
  "deniedDomains": ["example.com"],
  "fallbackMethod": "AUTO",
  "groups": ["example"],
  "id": "YWJjMTIzeHl6Nzg5",
  "name": "Example Name",
  "priority": 123.45,
  "privacyCategoryConfig": PrivacyCategoryConfigInput,
  "securityCategoryConfig": SecurityCategoryConfigInput
}

Response

{
  "data": {
    "dnsFilteringProfileUpdate": {
      "ok": true,
      "error": "example",
      "entity": DnsFilteringProfile
    }
  }
}

Mutations

gatewayCreate

Response

Returns a GatewayCreateMutation!

Arguments

Example

Query

mutation gatewayCreate(
  $address: String!,
  $remoteNetworkId: ID!,
  $sshCAId: ID,
  $x509CAId: ID!
) {
  gatewayCreate(
    address: $address,
    remoteNetworkId: $remoteNetworkId,
    sshCAId: $sshCAId,
    x509CAId: $x509CAId
  ) {
    ok
    error
    entity {
      ...GatewayFragment
    }
  }
}

Variables

{
  "address": "192.168.1.100",
  "remoteNetworkId": "TmV0d29yazox",
  "sshCAId": "abc123xyz789",
  "x509CAId": "abc123xyz789"
}

Response

{
  "data": {
    "gatewayCreate": {
      "ok": true,
      "error": "example",
      "entity": Gateway
    }
  }
}

Mutations

gatewayDelete

Response

Returns a GatewayDeleteMutation!

Arguments

Example

Query

mutation gatewayDelete($id: ID!) {
  gatewayDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"gatewayDelete": {"ok": true, "error": "example"}}}

Mutations

gatewayUpdate

Response

Returns a GatewayUpdateMutation!

Arguments

Example

Query

mutation gatewayUpdate(
  $address: String,
  $id: ID!,
  $remoteNetworkId: ID,
  $sshCAId: ID,
  $x509CAId: ID
) {
  gatewayUpdate(
    address: $address,
    id: $id,
    remoteNetworkId: $remoteNetworkId,
    sshCAId: $sshCAId,
    x509CAId: $x509CAId
  ) {
    ok
    error
    entity {
      ...GatewayFragment
    }
  }
}

Variables

{
  "address": "192.168.1.100",
  "id": "YWJjMTIzeHl6Nzg5",
  "remoteNetworkId": "TmV0d29yazox",
  "sshCAId": "abc123xyz789",
  "x509CAId": "abc123xyz789"
}

Response

{
  "data": {
    "gatewayUpdate": {
      "ok": true,
      "error": "example",
      "entity": Gateway
    }
  }
}

Mutations

groupCreate

Response

Returns a GroupCreateMutation!

Arguments

Example

Query

mutation groupCreate(
  $name: String!,
  $resourceIds: [ID],
  $securityPolicyId: ID,
  $userIds: [ID]
) {
  groupCreate(
    name: $name,
    resourceIds: $resourceIds,
    securityPolicyId: $securityPolicyId,
    userIds: $userIds
  ) {
    ok
    error
    entity {
      ...GroupFragment
    }
  }
}

Variables

{
  "name": "Example Name",
  "resourceIds": ["UmVzb3VyY2U6MQ"],
  "securityPolicyId": "abc123xyz789",
  "userIds": ["VXNlcjox"]
}

Response

{
  "data": {
    "groupCreate": {
      "ok": true,
      "error": "example",
      "entity": Group
    }
  }
}

Mutations

groupDelete

Response

Returns a GroupDeleteMutation!

Arguments

Example

Query

mutation groupDelete($id: ID!) {
  groupDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"groupDelete": {"ok": true, "error": "example"}}}

Mutations

groupUpdate

Response

Returns a GroupUpdateMutation!

Arguments

Example

Query

mutation groupUpdate(
  $addedResourceIds: [ID],
  $addedUserIds: [ID],
  $id: ID!,
  $isActive: Boolean,
  $name: String,
  $removedResourceIds: [ID],
  $removedUserIds: [ID],
  $resourceIds: [ID],
  $securityPolicyId: ID,
  $userIds: [ID]
) {
  groupUpdate(
    addedResourceIds: $addedResourceIds,
    addedUserIds: $addedUserIds,
    id: $id,
    isActive: $isActive,
    name: $name,
    removedResourceIds: $removedResourceIds,
    removedUserIds: $removedUserIds,
    resourceIds: $resourceIds,
    securityPolicyId: $securityPolicyId,
    userIds: $userIds
  ) {
    ok
    error
    entity {
      ...GroupFragment
    }
  }
}

Variables

{
  "addedResourceIds": ["UmVzb3VyY2U6MQ"],
  "addedUserIds": ["VXNlcjox"],
  "id": "YWJjMTIzeHl6Nzg5",
  "isActive": true,
  "name": "Example Name",
  "removedResourceIds": ["UmVzb3VyY2U6MQ"],
  "removedUserIds": ["VXNlcjox"],
  "resourceIds": ["UmVzb3VyY2U6MQ"],
  "securityPolicyId": "abc123xyz789",
  "userIds": ["VXNlcjox"]
}

Response

{
  "data": {
    "groupUpdate": {
      "ok": true,
      "error": "example",
      "entity": Group
    }
  }
}

Mutations

kubernetesResourceCreate

Response

Returns a KubernetesResourceCreateMutation!

Arguments

Example

Query

mutation kubernetesResourceCreate(
  $accessPolicy: AccessPolicyInput,
  $address: String!,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $clusterRef: String,
  $downstream: KubernetesDownstreamInput,
  $gatewayId: ID,
  $groupIds: [ID],
  $isVisible: Boolean,
  $name: String!,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID!,
  $securityPolicyId: ID,
  $tags: [TagInput!],
  $upstream: KubernetesUpstreamInput
) {
  kubernetesResourceCreate(
    accessPolicy: $accessPolicy,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    clusterRef: $clusterRef,
    downstream: $downstream,
    gatewayId: $gatewayId,
    groupIds: $groupIds,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    securityPolicyId: $securityPolicyId,
    tags: $tags,
    upstream: $upstream
  ) {
    ok
    error
    entity {
      ...KubernetesResourceFragment
    }
  }
}

Variables

{
  "accessPolicy": null,
  "address": "192.168.1.100",
  "alias": "example",
  "approvalMode": "MANUAL",
  "approverGroupIds": ["R3JvdXA6MQ"],
  "clusterRef": "example",
  "downstream": null,
  "gatewayId": "abc123xyz789",
  "groupIds": ["R3JvdXA6MQ"],
  "isVisible": true,
  "name": "Example Name",
  "protocols": null,
  "remoteNetworkId": "TmV0d29yazox",
  "securityPolicyId": "abc123xyz789",
  "tags": [TagInput],
  "upstream": null
}

Response

{
  "data": {
    "kubernetesResourceCreate": {
      "ok": true,
      "error": "example",
      "entity": KubernetesResource
    }
  }
}

Mutations

kubernetesResourceUpdate

Response

Returns a KubernetesResourceUpdateMutation!

Arguments

Example

Query

mutation kubernetesResourceUpdate(
  $accessPolicy: AccessPolicyInput,
  $addedApproverGroupIds: [ID!],
  $addedGroupIds: [ID],
  $address: String,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $clusterRef: String,
  $downstream: KubernetesDownstreamInput,
  $gatewayId: ID,
  $groupIds: [ID],
  $id: ID!,
  $isActive: Boolean,
  $isVisible: Boolean,
  $name: String,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID,
  $removedApproverGroupIds: [ID!],
  $removedGroupIds: [ID],
  $securityPolicyId: ID,
  $tags: [TagInput!],
  $upstream: KubernetesUpstreamInput
) {
  kubernetesResourceUpdate(
    accessPolicy: $accessPolicy,
    addedApproverGroupIds: $addedApproverGroupIds,
    addedGroupIds: $addedGroupIds,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    clusterRef: $clusterRef,
    downstream: $downstream,
    gatewayId: $gatewayId,
    groupIds: $groupIds,
    id: $id,
    isActive: $isActive,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    removedApproverGroupIds: $removedApproverGroupIds,
    removedGroupIds: $removedGroupIds,
    securityPolicyId: $securityPolicyId,
    tags: $tags,
    upstream: $upstream
  ) {
    ok
    error
    entity {
      ...KubernetesResourceFragment
    }
  }
}

Variables

{
  "accessPolicy": AccessPolicyInput,
  "addedApproverGroupIds": ["R3JvdXA6MQ"],
  "addedGroupIds": ["R3JvdXA6MQ"],
  "address": "192.168.1.100",
  "alias": "example",
  "approvalMode": "MANUAL",
  "approverGroupIds": ["R3JvdXA6MQ"],
  "clusterRef": "example",
  "downstream": null,
  "gatewayId": "abc123xyz789",
  "groupIds": ["R3JvdXA6MQ"],
  "id": "YWJjMTIzeHl6Nzg5",
  "isActive": true,
  "isVisible": true,
  "name": "Example Name",
  "protocols": null,
  "remoteNetworkId": "TmV0d29yazox",
  "removedApproverGroupIds": ["R3JvdXA6MQ"],
  "removedGroupIds": ["R3JvdXA6MQ"],
  "securityPolicyId": "abc123xyz789",
  "tags": [TagInput],
  "upstream": null
}

Response

{
  "data": {
    "kubernetesResourceUpdate": {
      "ok": true,
      "error": "example",
      "entity": KubernetesResource
    }
  }
}

Mutations

remoteNetworkCreate

Response

Returns a RemoteNetworkCreateMutation!

Arguments

Example

Query

mutation remoteNetworkCreate(
  $isActive: Boolean,
  $location: RemoteNetworkLocation,
  $name: String!,
  $networkType: RemoteNetworkType
) {
  remoteNetworkCreate(
    isActive: $isActive,
    location: $location,
    name: $name,
    networkType: $networkType
  ) {
    ok
    error
    entity {
      ...RemoteNetworkFragment
    }
  }
}

Variables

{
  "isActive": true,
  "location": "OTHER",
  "name": "Example Name",
  "networkType": "REGULAR"
}

Response

{
  "data": {
    "remoteNetworkCreate": {
      "ok": true,
      "error": "example",
      "entity": RemoteNetwork
    }
  }
}

Mutations

remoteNetworkDelete

Response

Returns a RemoteNetworkDeleteMutation!

Arguments

Example

Query

mutation remoteNetworkDelete($id: ID!) {
  remoteNetworkDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"remoteNetworkDelete": {"ok": true, "error": "example"}}}

Mutations

remoteNetworkUpdate

Response

Returns a RemoteNetworkUpdateMutation!

Arguments

Example

Query

mutation remoteNetworkUpdate(
  $id: ID!,
  $isActive: Boolean,
  $location: RemoteNetworkLocation,
  $name: String
) {
  remoteNetworkUpdate(
    id: $id,
    isActive: $isActive,
    location: $location,
    name: $name
  ) {
    ok
    error
    entity {
      ...RemoteNetworkFragment
    }
  }
}

Variables

{
  "id": "YWJjMTIzeHl6Nzg5",
  "isActive": true,
  "location": "null",
  "name": "Example Name"
}

Response

{
  "data": {
    "remoteNetworkUpdate": {
      "ok": true,
      "error": "example",
      "entity": RemoteNetwork
    }
  }
}

Mutations

resourceAccessAdd

Response

Returns a ResourceAccessAddMutation!

Arguments

Example

Query

mutation resourceAccessAdd(
  $access: [AccessInput!]!,
  $resourceId: ID!
) {
  resourceAccessAdd(
    access: $access,
    resourceId: $resourceId
  ) {
    ok
    error
    entity {
      ...ResourceFragment
    }
  }
}

Variables

{"access": [AccessInput], "resourceId": "UmVzb3VyY2U6MQ"}

Response

{
  "data": {
    "resourceAccessAdd": {
      "ok": true,
      "error": "example",
      "entity": Resource
    }
  }
}

Mutations

resourceAccessRemove

Response

Returns a ResourceAccessRemoveMutation!

Arguments

Example

Query

mutation resourceAccessRemove(
  $principalIds: [ID!]!,
  $resourceId: ID!
) {
  resourceAccessRemove(
    principalIds: $principalIds,
    resourceId: $resourceId
  ) {
    ok
    error
    entity {
      ...ResourceFragment
    }
  }
}

Variables

{"principalIds": ["abc123xyz789"], "resourceId": "UmVzb3VyY2U6MQ"}

Response

{
  "data": {
    "resourceAccessRemove": {
      "ok": true,
      "error": "example",
      "entity": Resource
    }
  }
}

Mutations

resourceAccessSet

Response

Returns a ResourceAccessSetMutation!

Arguments

Example

Query

mutation resourceAccessSet(
  $access: [AccessInput!]!,
  $resourceId: ID!
) {
  resourceAccessSet(
    access: $access,
    resourceId: $resourceId
  ) {
    ok
    error
    entity {
      ...ResourceFragment
    }
  }
}

Variables

{"access": [AccessInput], "resourceId": "UmVzb3VyY2U6MQ"}

Response

{
  "data": {
    "resourceAccessSet": {
      "ok": true,
      "error": "example",
      "entity": Resource
    }
  }
}

Mutations

resourceCreate

Response

Returns a ResourceCreateMutation!

Arguments

Example

Query

mutation resourceCreate(
  $accessPolicy: AccessPolicyInput,
  $address: String!,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $groupIds: [ID],
  $isBrowserShortcutEnabled: Boolean,
  $isVisible: Boolean,
  $name: String!,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID!,
  $routingMode: RoutingMode,
  $securityPolicyId: ID,
  $tags: [TagInput!]
) {
  resourceCreate(
    accessPolicy: $accessPolicy,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    groupIds: $groupIds,
    isBrowserShortcutEnabled: $isBrowserShortcutEnabled,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    routingMode: $routingMode,
    securityPolicyId: $securityPolicyId,
    tags: $tags
  ) {
    ok
    error
    entity {
      ...NetworkResourceFragment
    }
  }
}

Variables

{
  "accessPolicy": null,
  "address": "192.168.1.100",
  "alias": "example",
  "approvalMode": "MANUAL",
  "approverGroupIds": ["R3JvdXA6MQ"],
  "groupIds": ["R3JvdXA6MQ"],
  "isBrowserShortcutEnabled": true,
  "isVisible": true,
  "name": "Example Name",
  "protocols": null,
  "remoteNetworkId": "TmV0d29yazox",
  "routingMode": "null",
  "securityPolicyId": "abc123xyz789",
  "tags": [TagInput]
}

Response

{
  "data": {
    "resourceCreate": {
      "ok": true,
      "error": "example",
      "entity": NetworkResource
    }
  }
}

Mutations

resourceDelete

Response

Returns a ResourceDeleteMutation!

Arguments

Example

Query

mutation resourceDelete($id: ID!) {
  resourceDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"resourceDelete": {"ok": true, "error": "example"}}}

Mutations

resourceUpdate

Response

Returns a ResourceUpdateMutation!

Arguments

Example

Query

mutation resourceUpdate(
  $accessPolicy: AccessPolicyInput,
  $addedApproverGroupIds: [ID!],
  $addedGroupIds: [ID],
  $address: String,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $groupIds: [ID],
  $id: ID!,
  $isActive: Boolean,
  $isBrowserShortcutEnabled: Boolean,
  $isVisible: Boolean,
  $name: String,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID,
  $removedApproverGroupIds: [ID!],
  $removedGroupIds: [ID],
  $routingMode: RoutingMode,
  $securityPolicyId: ID,
  $tags: [TagInput!]
) {
  resourceUpdate(
    accessPolicy: $accessPolicy,
    addedApproverGroupIds: $addedApproverGroupIds,
    addedGroupIds: $addedGroupIds,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    groupIds: $groupIds,
    id: $id,
    isActive: $isActive,
    isBrowserShortcutEnabled: $isBrowserShortcutEnabled,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    removedApproverGroupIds: $removedApproverGroupIds,
    removedGroupIds: $removedGroupIds,
    routingMode: $routingMode,
    securityPolicyId: $securityPolicyId,
    tags: $tags
  ) {
    ok
    error
    entity {
      ...NetworkResourceFragment
    }
  }
}

Variables

{
  "accessPolicy": AccessPolicyInput,
  "addedApproverGroupIds": ["R3JvdXA6MQ"],
  "addedGroupIds": ["R3JvdXA6MQ"],
  "address": "192.168.1.100",
  "alias": "example",
  "approvalMode": "MANUAL",
  "approverGroupIds": ["R3JvdXA6MQ"],
  "groupIds": ["R3JvdXA6MQ"],
  "id": "YWJjMTIzeHl6Nzg5",
  "isActive": true,
  "isBrowserShortcutEnabled": true,
  "isVisible": true,
  "name": "Example Name",
  "protocols": null,
  "remoteNetworkId": "TmV0d29yazox",
  "removedApproverGroupIds": ["R3JvdXA6MQ"],
  "removedGroupIds": ["R3JvdXA6MQ"],
  "routingMode": "THROUGH_TWINGATE",
  "securityPolicyId": "abc123xyz789",
  "tags": [TagInput]
}

Response

{
  "data": {
    "resourceUpdate": {
      "ok": true,
      "error": "example",
      "entity": NetworkResource
    }
  }
}

Mutations

securityPolicyUpdate

Response

Returns a SecurityPolicyUpdateMutation!

Arguments

Example

Query

mutation securityPolicyUpdate(
  $addedGroupIds: [ID],
  $groupIds: [ID],
  $id: ID!,
  $removedGroupIds: [ID]
) {
  securityPolicyUpdate(
    addedGroupIds: $addedGroupIds,
    groupIds: $groupIds,
    id: $id,
    removedGroupIds: $removedGroupIds
  ) {
    ok
    error
    entity {
      ...SecurityPolicyFragment
    }
  }
}

Variables

{
  "addedGroupIds": ["R3JvdXA6MQ"],
  "groupIds": ["R3JvdXA6MQ"],
  "id": "YWJjMTIzeHl6Nzg5",
  "removedGroupIds": ["R3JvdXA6MQ"]
}

Response

{
  "data": {
    "securityPolicyUpdate": {
      "ok": true,
      "error": "example",
      "entity": SecurityPolicy
    }
  }
}

Mutations

serialNumbersCreate

Response

Returns a SerialNumbersCreateMutation!

Arguments

Example

Query

mutation serialNumbersCreate($serialNumbers: [String!]!) {
  serialNumbersCreate(serialNumbers: $serialNumbers) {
    ok
    error
    entities {
      ...SerialNumberFragment
    }
  }
}

Variables

{"serialNumbers": ["example"]}

Response

{
  "data": {
    "serialNumbersCreate": {
      "ok": true,
      "error": "example",
      "entities": [SerialNumber]
    }
  }
}

Mutations

serialNumbersDelete

Response

Returns a SerialNumbersDeleteMutation!

Arguments

Example

Query

mutation serialNumbersDelete($serialNumbers: [String!]!) {
  serialNumbersDelete(serialNumbers: $serialNumbers) {
    ok
    error
  }
}

Variables

{"serialNumbers": ["example"]}

Response

{"data": {"serialNumbersDelete": {"ok": true, "error": "example"}}}

Mutations

serviceAccountCreate

Response

Returns a ServiceAccountCreateMutation!

Arguments

Example

Query

mutation serviceAccountCreate(
  $name: String!,
  $resourceIds: [ID]
) {
  serviceAccountCreate(
    name: $name,
    resourceIds: $resourceIds
  ) {
    ok
    error
    entity {
      ...ServiceAccountFragment
    }
  }
}

Variables

{"name": "Example Name", "resourceIds": ["UmVzb3VyY2U6MQ"]}

Response

{
  "data": {
    "serviceAccountCreate": {
      "ok": true,
      "error": "example",
      "entity": ServiceAccount
    }
  }
}

Mutations

serviceAccountDelete

Response

Returns a ServiceAccountDeleteMutation!

Arguments

Example

Query

mutation serviceAccountDelete($id: ID!) {
  serviceAccountDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"serviceAccountDelete": {"ok": true, "error": "example"}}}

Mutations

serviceAccountKeyCreate

Response

Returns a ServiceAccountKeyCreateMutation!

Arguments

Example

Query

mutation serviceAccountKeyCreate(
  $expirationTime: Int!,
  $name: String,
  $serviceAccountId: ID!
) {
  serviceAccountKeyCreate(
    expirationTime: $expirationTime,
    name: $name,
    serviceAccountId: $serviceAccountId
  ) {
    ok
    error
    entity {
      ...ServiceAccountKeyFragment
    }
    token
  }
}

Variables

{
  "expirationTime": 12345,
  "name": "Example Name",
  "serviceAccountId": "abc123xyz789"
}

Response

{
  "data": {
    "serviceAccountKeyCreate": {
      "ok": true,
      "error": "example",
      "entity": ServiceAccountKey,
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
    }
  }
}

Mutations

serviceAccountKeyDelete

Response

Returns a ServiceAccountKeyDeleteMutation!

Arguments

Example

Query

mutation serviceAccountKeyDelete($id: ID!) {
  serviceAccountKeyDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"serviceAccountKeyDelete": {"ok": true, "error": "example"}}}

Mutations

serviceAccountKeyRevoke

Response

Returns a ServiceAccountKeyRevokeMutation!

Arguments

Example

Query

mutation serviceAccountKeyRevoke($id: ID!) {
  serviceAccountKeyRevoke(id: $id) {
    ok
    error
    entity {
      ...ServiceAccountKeyFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "serviceAccountKeyRevoke": {
      "ok": true,
      "error": "example",
      "entity": ServiceAccountKey
    }
  }
}

Mutations

serviceAccountKeyUpdate

Response

Returns a ServiceAccountKeyUpdateMutation!

Arguments

Example

Query

mutation serviceAccountKeyUpdate(
  $id: ID!,
  $name: String!
) {
  serviceAccountKeyUpdate(
    id: $id,
    name: $name
  ) {
    ok
    error
    entity {
      ...ServiceAccountKeyFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5", "name": "Example Name"}

Response

{
  "data": {
    "serviceAccountKeyUpdate": {
      "ok": true,
      "error": "example",
      "entity": ServiceAccountKey
    }
  }
}

Mutations

serviceAccountUpdate

Response

Returns a ServiceAccountUpdateMutation!

Arguments

Example

Query

mutation serviceAccountUpdate(
  $addedResourceIds: [ID],
  $id: ID!,
  $name: String,
  $removedResourceIds: [ID],
  $resourceIds: [ID]
) {
  serviceAccountUpdate(
    addedResourceIds: $addedResourceIds,
    id: $id,
    name: $name,
    removedResourceIds: $removedResourceIds,
    resourceIds: $resourceIds
  ) {
    ok
    error
    entity {
      ...ServiceAccountFragment
    }
  }
}

Variables

{
  "addedResourceIds": ["UmVzb3VyY2U6MQ"],
  "id": "YWJjMTIzeHl6Nzg5",
  "name": "Example Name",
  "removedResourceIds": ["UmVzb3VyY2U6MQ"],
  "resourceIds": ["UmVzb3VyY2U6MQ"]
}

Response

{
  "data": {
    "serviceAccountUpdate": {
      "ok": true,
      "error": "example",
      "entity": ServiceAccount
    }
  }
}

Mutations

sshCertificateAuthorityCreate

Response

Returns an SSHCertificateAuthorityCreateMutation!

Arguments

Example

Query

mutation sshCertificateAuthorityCreate(
  $name: String!,
  $publicKey: String!
) {
  sshCertificateAuthorityCreate(
    name: $name,
    publicKey: $publicKey
  ) {
    ok
    error
    entity {
      ...SSHCertificateAuthorityFragment
    }
  }
}

Variables

{"name": "Example Name", "publicKey": "sk_test_1234567890abcdef"}

Response

{
  "data": {
    "sshCertificateAuthorityCreate": {
      "ok": true,
      "error": "example",
      "entity": SSHCertificateAuthority
    }
  }
}

Mutations

sshCertificateAuthorityDelete

Response

Returns an SSHCertificateAuthorityDeleteMutation!

Arguments

Example

Query

mutation sshCertificateAuthorityDelete($id: ID!) {
  sshCertificateAuthorityDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"sshCertificateAuthorityDelete": {"ok": true, "error": "example"}}}

Mutations

sshResourceCreate

Response

Returns an SSHResourceCreateMutation!

Arguments

Example

Query

mutation sshResourceCreate(
  $accessPolicy: AccessPolicyInput,
  $address: String!,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $downstream: SSHDownstreamInput,
  $gatewayId: ID!,
  $groupIds: [ID],
  $isVisible: Boolean,
  $name: String!,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID!,
  $securityPolicyId: ID,
  $tags: [TagInput!],
  $upstream: SSHUpstreamInput
) {
  sshResourceCreate(
    accessPolicy: $accessPolicy,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    downstream: $downstream,
    gatewayId: $gatewayId,
    groupIds: $groupIds,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    securityPolicyId: $securityPolicyId,
    tags: $tags,
    upstream: $upstream
  ) {
    ok
    error
    entity {
      ...SSHResourceFragment
    }
  }
}

Variables

{
  "accessPolicy": null,
  "address": "192.168.1.100",
  "alias": "example",
  "approvalMode": "MANUAL",
  "approverGroupIds": ["R3JvdXA6MQ"],
  "downstream": null,
  "gatewayId": "abc123xyz789",
  "groupIds": ["R3JvdXA6MQ"],
  "isVisible": true,
  "name": "Example Name",
  "protocols": null,
  "remoteNetworkId": "TmV0d29yazox",
  "securityPolicyId": "abc123xyz789",
  "tags": [TagInput],
  "upstream": null
}

Response

{
  "data": {
    "sshResourceCreate": {
      "ok": true,
      "error": "example",
      "entity": SSHResource
    }
  }
}

Mutations

sshResourceUpdate

Response

Returns an SSHResourceUpdateMutation!

Arguments

Example

Query

mutation sshResourceUpdate(
  $accessPolicy: AccessPolicyInput,
  $addedApproverGroupIds: [ID!],
  $addedGroupIds: [ID],
  $address: String,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $downstream: SSHDownstreamInput,
  $gatewayId: ID,
  $groupIds: [ID],
  $id: ID!,
  $isActive: Boolean,
  $isVisible: Boolean,
  $name: String,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID,
  $removedApproverGroupIds: [ID!],
  $removedGroupIds: [ID],
  $securityPolicyId: ID,
  $tags: [TagInput!],
  $upstream: SSHUpstreamInput
) {
  sshResourceUpdate(
    accessPolicy: $accessPolicy,
    addedApproverGroupIds: $addedApproverGroupIds,
    addedGroupIds: $addedGroupIds,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    downstream: $downstream,
    gatewayId: $gatewayId,
    groupIds: $groupIds,
    id: $id,
    isActive: $isActive,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    removedApproverGroupIds: $removedApproverGroupIds,
    removedGroupIds: $removedGroupIds,
    securityPolicyId: $securityPolicyId,
    tags: $tags,
    upstream: $upstream
  ) {
    ok
    error
    entity {
      ...SSHResourceFragment
    }
  }
}

Variables

{
  "accessPolicy": AccessPolicyInput,
  "addedApproverGroupIds": ["R3JvdXA6MQ"],
  "addedGroupIds": ["R3JvdXA6MQ"],
  "address": "192.168.1.100",
  "alias": "example",
  "approvalMode": "MANUAL",
  "approverGroupIds": ["R3JvdXA6MQ"],
  "downstream": null,
  "gatewayId": "abc123xyz789",
  "groupIds": ["R3JvdXA6MQ"],
  "id": "YWJjMTIzeHl6Nzg5",
  "isActive": true,
  "isVisible": true,
  "name": "Example Name",
  "protocols": null,
  "remoteNetworkId": "TmV0d29yazox",
  "removedApproverGroupIds": ["R3JvdXA6MQ"],
  "removedGroupIds": ["R3JvdXA6MQ"],
  "securityPolicyId": "abc123xyz789",
  "tags": [TagInput],
  "upstream": null
}

Response

{
  "data": {
    "sshResourceUpdate": {
      "ok": true,
      "error": "example",
      "entity": SSHResource
    }
  }
}

Mutations

userCreate

Response

Returns a UserCreateMutation!

Arguments

Example

Query

mutation userCreate(
  $email: String!,
  $firstName: String,
  $lastName: String,
  $role: UserRole
) {
  userCreate(
    email: $email,
    firstName: $firstName,
    lastName: $lastName,
    role: $role
  ) {
    ok
    error
    entity {
      ...UserFragment
    }
  }
}

Variables

{
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "role": "MEMBER"
}

Response

{
  "data": {
    "userCreate": {
      "ok": true,
      "error": "example",
      "entity": User
    }
  }
}

Mutations

userDelete

Response

Returns a UserDeleteMutation!

Arguments

Example

Query

mutation userDelete($id: ID!) {
  userDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"userDelete": {"ok": true, "error": "example"}}}

Mutations

userDetailsUpdate

Response

Returns a UserDetailsUpdateMutation!

Arguments

Example

Query

mutation userDetailsUpdate(
  $firstName: String,
  $id: ID!,
  $lastName: String,
  $state: UserStateUpdateInput
) {
  userDetailsUpdate(
    firstName: $firstName,
    id: $id,
    lastName: $lastName,
    state: $state
  ) {
    ok
    error
    entity {
      ...UserFragment
    }
  }
}

Variables

{
  "firstName": "John",
  "id": "YWJjMTIzeHl6Nzg5",
  "lastName": "Doe",
  "state": "null"
}

Response

{
  "data": {
    "userDetailsUpdate": {
      "ok": true,
      "error": "example",
      "entity": User
    }
  }
}

Mutations

userResetMfa

Response

Returns an UserResetMFAMutation!

Arguments

Example

Query

mutation userResetMfa($id: ID!) {
  userResetMfa(id: $id) {
    ok
    error
    entity {
      ...UserFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{
  "data": {
    "userResetMfa": {
      "ok": true,
      "error": "example",
      "entity": User
    }
  }
}

Mutations

userRoleUpdate

Response

Returns a UserRoleUpdateMutation!

Arguments

Example

Query

mutation userRoleUpdate(
  $id: ID!,
  $role: UserRole!
) {
  userRoleUpdate(
    id: $id,
    role: $role
  ) {
    ok
    error
    entity {
      ...UserFragment
    }
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5", "role": "ADMIN"}

Response

{
  "data": {
    "userRoleUpdate": {
      "ok": true,
      "error": "example",
      "entity": User
    }
  }
}

Mutations

webAppResourceCreate

Response

Returns a WebAppResourceCreateMutation!

Arguments

Example

Query

mutation webAppResourceCreate(
  $accessPolicy: AccessPolicyInput,
  $address: String!,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $downstream: WebAppDownstreamInput!,
  $gatewayId: ID!,
  $groupIds: [ID],
  $isVisible: Boolean,
  $name: String!,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID!,
  $requestHeaderRewrites: [KeyValueInputObject!],
  $securityPolicyId: ID,
  $tags: [TagInput!],
  $upstream: WebAppUpstreamInput!
) {
  webAppResourceCreate(
    accessPolicy: $accessPolicy,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    downstream: $downstream,
    gatewayId: $gatewayId,
    groupIds: $groupIds,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    requestHeaderRewrites: $requestHeaderRewrites,
    securityPolicyId: $securityPolicyId,
    tags: $tags,
    upstream: $upstream
  ) {
    ok
    error
    entity {
      ...WebAppResourceFragment
    }
  }
}

Variables

{
  "accessPolicy": null,
  "address": "192.168.1.100",
  "alias": "example",
  "approvalMode": "MANUAL",
  "approverGroupIds": ["R3JvdXA6MQ"],
  "downstream": WebAppDownstreamInput,
  "gatewayId": "abc123xyz789",
  "groupIds": ["R3JvdXA6MQ"],
  "isVisible": true,
  "name": "Example Name",
  "protocols": null,
  "remoteNetworkId": "TmV0d29yazox",
  "requestHeaderRewrites": [""],
  "securityPolicyId": "abc123xyz789",
  "tags": [TagInput],
  "upstream": WebAppUpstreamInput
}

Response

{
  "data": {
    "webAppResourceCreate": {
      "ok": true,
      "error": "example",
      "entity": WebAppResource
    }
  }
}

Mutations

webAppResourceUpdate

Response

Returns a WebAppResourceUpdateMutation!

Arguments

Example

Query

mutation webAppResourceUpdate(
  $accessPolicy: AccessPolicyInput,
  $addedApproverGroupIds: [ID!],
  $addedGroupIds: [ID],
  $address: String,
  $alias: String,
  $approvalMode: AccessApprovalMode,
  $approverGroupIds: [ID!],
  $downstream: WebAppDownstreamInput,
  $gatewayId: ID,
  $groupIds: [ID],
  $id: ID!,
  $isActive: Boolean,
  $isVisible: Boolean,
  $name: String,
  $protocols: ProtocolsInput,
  $remoteNetworkId: ID,
  $removedApproverGroupIds: [ID!],
  $removedGroupIds: [ID],
  $requestHeaderRewrites: [KeyValueInputObject!],
  $securityPolicyId: ID,
  $tags: [TagInput!],
  $upstream: WebAppUpstreamInput
) {
  webAppResourceUpdate(
    accessPolicy: $accessPolicy,
    addedApproverGroupIds: $addedApproverGroupIds,
    addedGroupIds: $addedGroupIds,
    address: $address,
    alias: $alias,
    approvalMode: $approvalMode,
    approverGroupIds: $approverGroupIds,
    downstream: $downstream,
    gatewayId: $gatewayId,
    groupIds: $groupIds,
    id: $id,
    isActive: $isActive,
    isVisible: $isVisible,
    name: $name,
    protocols: $protocols,
    remoteNetworkId: $remoteNetworkId,
    removedApproverGroupIds: $removedApproverGroupIds,
    removedGroupIds: $removedGroupIds,
    requestHeaderRewrites: $requestHeaderRewrites,
    securityPolicyId: $securityPolicyId,
    tags: $tags,
    upstream: $upstream
  ) {
    ok
    error
    entity {
      ...WebAppResourceFragment
    }
  }
}

Variables

Response

{
  "data": {
    "webAppResourceUpdate": {
      "ok": true,
      "error": "example",
      "entity": WebAppResource
    }
  }
}

Mutations

x509CertificateAuthorityCreate

Response

Returns a X509CertificateAuthorityCreateMutation!

Arguments

Example

Query

mutation x509CertificateAuthorityCreate(
  $certificate: String!,
  $name: String!
) {
  x509CertificateAuthorityCreate(
    certificate: $certificate,
    name: $name
  ) {
    ok
    error
    entity {
      ...X509CertificateAuthorityFragment
    }
  }
}

Variables

{"certificate": "example", "name": "Example Name"}

Response

{
  "data": {
    "x509CertificateAuthorityCreate": {
      "ok": true,
      "error": "example",
      "entity": X509CertificateAuthority
    }
  }
}

Mutations

x509CertificateAuthorityDelete

Response

Returns a X509CertificateAuthorityDeleteMutation!

Arguments

Example

Query

mutation x509CertificateAuthorityDelete($id: ID!) {
  x509CertificateAuthorityDelete(id: $id) {
    ok
    error
  }
}

Variables

{"id": "YWJjMTIzeHl6Nzg5"}

Response

{"data": {"x509CertificateAuthorityDelete": {"ok": true, "error": "example"}}}

Types

AccessApprovalMode

Values

Example

"MANUAL"

Types

AccessConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [AccessEdge],
  "totalCount": 10
}

Types

AccessEdge

Description

A Relay edge containing a Access and its cursor.

Fields

Example

{
  "node": Group,
  "cursor": "example",
  "securityPolicy": SecurityPolicy,
  "expiresAt": "2024-12-31T23:59:59.000Z",
  "usageBasedAutolockDurationDays": 12345,
  "accessPolicy": AccessPolicy,
  "approvalMode": "MANUAL"
}

Types

AccessFilterInput

Fields

Example

{"principalType": PrincipleTypeFilterOperatorInput}

Types

AccessInput

Fields

Example

{
  "principalId": "abc123xyz789",
  "securityPolicyId": "abc123xyz789",
  "expiresAt": "2024-12-31T23:59:59.000Z",
  "accessPolicy": AccessPolicyInput,
  "approvalMode": "MANUAL"
}

Types

AccessMode

Values

Example

"MANUAL"

Types

AccessPolicy

Fields

Example

{"mode": "MANUAL", "durationSeconds": 12345}

Types

AccessPolicyInput

Fields

Example

{"mode": "MANUAL", "durationSeconds": 12345}

Types

AccessRequest

Fields

Example

{
  "reason": "example",
  "requestedAt": "2024-01-01T00:00:00.000Z",
  "id": "YWJjMTIzeHl6Nzg5",
  "user": User,
  "resource": Resource,
  "status": "PENDING"
}

Types

AccessRequestApproveMutation

Fields

Example

{"ok": true, "error": "example"}

Types

AccessRequestConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [AccessRequestEdge],
  "totalCount": 10
}

Types

AccessRequestEdge

Description

A Relay edge containing a AccessRequest and its cursor.

Fields

Example

{"node": AccessRequest, "cursor": "example"}

Types

AccessRequestFilterInput

Fields

Example

{
  "userId": UserIdFilterOperationInput,
  "resourceId": ResourceIdFilterOperationInput,
  "status": AccessRequestStatusFilterOperatorInput
}

Types

AccessRequestRejectMutation

Fields

Example

{"ok": true, "error": "example"}

Types

AccessRequestStatus

Values

Example

"PENDING"

Types

AccessRequestStatusFilterOperatorInput

Description

Filter input object for a AccessRequestStatus enum field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["PENDING"]}

Types

AddressType

Values

Example

"IP"

Types

BasePostureCheck

Fields

Possible Types

Example

{"isSatisfied": "YES"}

Types

BaseVerification

Fields

Possible Types

Example

{"isVerified": true}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

BooleanFilterOperatorInput

Description

Filter input object for a boolean field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"eq": true}

Types

CertificateAuthority

Types

Example

X509CertificateAuthority

Types

CertificateAuthorityConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [CertificateAuthorityEdge],
  "totalCount": 10
}

Types

CertificateAuthorityEdge

Description

A Relay edge containing a CertificateAuthority and its cursor.

Fields

Example

{"node": X509CertificateAuthority, "cursor": "example"}

Types

Connector

Fields

Example

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-15T00:00:00.000Z",
  "lastHeartbeatAt": "2024-01-01T00:00:00.000Z",
  "hostname": "server.example.com",
  "id": "YWJjMTIzeHl6Nzg5",
  "name": "Example Name",
  "remoteNetwork": RemoteNetwork,
  "state": "ALIVE",
  "hasStatusNotificationsEnabled": true,
  "version": "1.0.0",
  "publicIP": "192.168.1.1",
  "privateIPs": ["192.168.1.1"]
}

Types

ConnectorConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [ConnectorEdge],
  "totalCount": 10
}

Types

ConnectorCreateMutation

Fields

Example

{"ok": true, "error": "example", "entity": Connector}

Types

ConnectorDeleteMutation

Fields

Example

{"ok": true, "error": "example"}

Types

ConnectorEdge

Description

A Relay edge containing a Connector and its cursor.

Fields

Example

{"node": Connector, "cursor": "example"}

Types

ConnectorFilterInput

Fields

Example

{
  "name": StringFilterOperatorInput,
  "state": ConnectorStateFilterOperatorInput
}

Types

ConnectorGenerateTokensMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "connectorTokens": ConnectorTokens
}

Types

ConnectorState

Values

Example

"ALIVE"

Types

ConnectorStateFilterOperatorInput

Description

Filter input object for a ConnectorState enum field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["ALIVE"]}

Types

ConnectorTokens

Fields

Example

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

Types

ConnectorUpdateMutation

Fields

Example

{"ok": true, "error": "example", "entity": Connector}

Types

ContentCategoryConfig

Fields

Example

{
  "blockGambling": true,
  "blockDating": true,
  "blockAdultContent": true,
  "blockSocialMedia": true,
  "blockGames": true,
  "blockStreaming": true,
  "blockPiracy": true,
  "enableYoutubeRestrictedMode": true,
  "enableSafeSearch": true
}

Types

ContentCategoryConfigInput

Fields

Example

Types

DateTime

Description

The DateTime scalar type represents a DateTime value as specified by iso8601.

Example

"2024-01-01T00:00:00.000Z"

Types

Device

Fields

Example

{
  "id": "YWJjMTIzeHl6Nzg5",
  "name": "Example Name",
  "lastFailedLoginAt": "2024-01-01T00:00:00.000Z",
  "osVersion": "1.0.0",
  "hardwareModel": "example",
  "hostname": "server.example.com",
  "username": "johndoe",
  "serialNumber": "example",
  "user": User,
  "lastConnectedAt": "2024-01-01T00:00:00.000Z",
  "osName": "IPADOS",
  "deviceType": "GENERIC",
  "activeState": "ACTIVE",
  "lastSuccessfulLoginAt": "2024-01-01T00:00:00.000Z",
  "isTrusted": true,
  "clientVersion": "1.0.0",
  "manufacturerName": "example",
  "internetSecurityConfiguration": "example"
}

Types

DeviceActiveState

Description

The Device's active state.

Values

Example

"ACTIVE"

Types

DeviceActiveStateFilterOperatorInput

Description

Filter input object for a DeviceActiveState enum field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["ACTIVE"]}

Types

DeviceArchiveMutation

Fields

Example

{"ok": true, "error": "example", "entity": Device}

Types

DeviceBlockMutation

Fields

Example

{"ok": true, "error": "example", "entity": Device}

Types

DeviceConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [DeviceEdge],
  "totalCount": 10
}

Types

DeviceEdge

Description

A Relay edge containing a Device and its cursor.

Fields

Example

{"node": Device, "cursor": "example"}

Types

DeviceFilterInput

Fields

Example

{
  "isTrusted": BooleanFilterOperatorInput,
  "serialNumber": StringFilterOperatorInput,
  "activeState": DeviceActiveStateFilterOperatorInput,
  "userId": UserIdFilterOperationInput
}

Types

DeviceOsName

Description

The name of the Device's operating system.

Values

Example

"IPADOS"

Types

DevicePosture

Fields

Example

{
  "hardDriveEncryption": DevicePropertyPostureCheck,
  "screenLockPasscode": DevicePropertyPostureCheck,
  "firewall": DevicePropertyPostureCheck,
  "biometric": DevicePropertyPostureCheck,
  "antivirus": DevicePropertyPostureCheck,
  "osVersion": OsVersionPostureCheck,
  "crowdstrike": TrustProviderVerification,
  "jamf": TrustProviderVerification,
  "kandji": TrustProviderVerification,
  "iru": TrustProviderVerification,
  "inTune": TrustProviderVerification,
  "sentinelOne": TrustProviderVerification,
  "onePassword": TrustProviderVerification,
  "manualVerification": ManualVerification
}

Types

DevicePropertyPostureCheck

Fields

Example

{"isSatisfied": "YES", "detected": true}

Types

DeviceType

Description

The Device's type, e.g. LAPTOP, DESKTOP, or MOBILE.

Values

Example

"GENERIC"

Types

DeviceUnarchiveMutation

Fields

Example

{"ok": true, "error": "example", "entity": Device}

Types

DeviceUnblockMutation

Fields

Example

{"ok": true, "error": "example", "entity": Device}

Types

DeviceUpdateMutation

Fields

Example

{"ok": true, "error": "example", "entity": Device}

Types

DnsFilteringProfile

Fields

Example

{
  "name": "Example Name",
  "id": "YWJjMTIzeHl6Nzg5",
  "priority": 123.45,
  "fallbackMethod": "AUTO",
  "groups": GroupConnection,
  "allowedDomains": ["example.com"],
  "deniedDomains": ["example.com"],
  "contentCategoryConfig": ContentCategoryConfig,
  "securityCategoryConfig": SecurityCategoryConfig,
  "privacyCategoryConfig": PrivacyCategoryConfig
}

Types

DnsFilteringProfileCreateMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "entity": DnsFilteringProfile
}

Types

DnsFilteringProfileDeleteMutation

Fields

Example

{"ok": true, "error": "example"}

Types

DnsFilteringProfileMetadata

Fields

Example

{"name": "Example Name", "id": "YWJjMTIzeHl6Nzg5", "priority": 123.45}

Types

DnsFilteringProfileUpdateMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "entity": DnsFilteringProfile
}

Types

DohFallbackMethod

Values

Example

"AUTO"

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

Gateway

Fields

Example

{
  "address": "192.168.1.100",
  "id": "YWJjMTIzeHl6Nzg5",
  "remoteNetwork": RemoteNetwork,
  "x509CA": X509CertificateAuthority,
  "sshCA": SSHCertificateAuthority
}

Types

GatewayConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [GatewayEdge],
  "totalCount": 10
}

Types

GatewayCreateMutation

Fields

Example

{"ok": true, "error": "example", "entity": Gateway}

Types

GatewayDeleteMutation

Fields

Example

{"ok": true, "error": "example"}

Types

GatewayEdge

Description

A Relay edge containing a Gateway and its cursor.

Fields

Example

{"node": Gateway, "cursor": "example"}

Types

GatewayUpdateMutation

Fields

Example

{"ok": true, "error": "example", "entity": Gateway}

Types

Group

Fields

Example

{
  "id": "YWJjMTIzeHl6Nzg5",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-15T00:00:00.000Z",
  "name": "Example Name",
  "originId": "example",
  "isActive": true,
  "type": "MANUAL",
  "users": UserConnection,
  "resources": ResourceConnection,
  "securityPolicy": SecurityPolicy
}

Types

GroupConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [GroupEdge],
  "totalCount": 10
}

Types

GroupCreateMutation

Fields

Example

{"ok": true, "error": "example", "entity": Group}

Types

GroupDeleteMutation

Fields

Example

{"ok": true, "error": "example"}

Types

GroupEdge

Description

A Relay edge containing a Group and its cursor.

Fields

Example

{"node": Group, "cursor": "example"}

Types

GroupFilterInput

Fields

Example

{
  "name": StringFilterOperatorInput,
  "type": GroupTypeFilterOperatorInput,
  "isActive": BooleanFilterOperatorInput,
  "originId": StringFilterOperatorInput
}

Types

GroupType

Values

Example

"MANUAL"

Types

GroupTypeFilterOperatorInput

Description

Filter input object for a GroupType enum field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["MANUAL"]}

Types

GroupUpdateMutation

Fields

Example

{"ok": true, "error": "example", "entity": Group}

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"YWJjMTIzeHl6Nzg5"

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

12345

Types

KeyValueInputObject

Fields

Example

{"key": "sk_test_1234567890abcdef", "value": "example"}

Types

KeyValuePair

Fields

Example

{"key": "sk_test_1234567890abcdef", "value": "example"}

Types

KubernetesDownstreamInput

Fields

Example

{"port": 443}

Types

KubernetesResource

Fields

Example

{
  "id": "YWJjMTIzeHl6Nzg5",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-15T00:00:00.000Z",
  "name": "Example Name",
  "tags": [Tag],
  "address": ResourceAddress,
  "alias": "example",
  "protocols": ResourceProtocols,
  "isActive": true,
  "remoteNetwork": RemoteNetwork,
  "groups": GroupConnection,
  "serviceAccounts": ServiceAccountConnection,
  "access": AccessConnection,
  "isVisible": true,
  "isBrowserShortcutEnabled": true,
  "securityPolicy": SecurityPolicy,
  "usageBasedAutolockDurationDays": 12345,
  "accessPolicy": AccessPolicy,
  "approvalMode": "MANUAL",
  "approverGroups": GroupConnection,
  "proxyAddress": "192.168.1.100",
  "certificateAuthorityCert": "example",
  "gateway": Gateway,
  "clusterRef": "example",
  "downstream": KubernetesResourceDownstream,
  "upstream": KubernetesResourceUpstream
}

Types

KubernetesResourceCreateMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "entity": KubernetesResource
}

Types

KubernetesResourceDownstream

Fields

Example

{"port": 443}

Types

KubernetesResourceUpdateMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "entity": KubernetesResource
}

Types

KubernetesResourceUpstream

Fields

Example

{"port": 443}

Types

KubernetesUpstreamInput

Fields

Example

{"port": 443}

Types

ManualVerification

Fields

Example

{"isVerified": true, "value": "SERIAL_NUMBER_VERIFIED"}

Types

ManualVerificationValue

Values

Example

"SERIAL_NUMBER_VERIFIED"

Types

NetworkResource

Fields

Example

Types

Node

Description

An object with an ID

Fields

Possible Types

Example

{"id": "YWJjMTIzeHl6Nzg5"}

Types

OsVersionPostureCheck

Fields

Example

{"isSatisfied": "YES", "version": "1.0.0"}

Types

PageInfo

Description

The Relay compliant PageInfo type, containing data necessary to paginate this connection.

Fields

Example

{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "example",
  "endCursor": "example"
}

Types

PortRange

Fields

Example

{"start": 12345, "end": 12345}

Types

PortRangeInput

Fields

Example

{"start": 12345, "end": 12345}

Types

PostureStatus

Values

Example

"YES"

Types

Principal

Types

Example

Group

Types

PrincipalType

Values

Example

"GROUP"

Types

PrincipleTypeFilterOperatorInput

Description

Filter input object for a PrincipalType enum field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["GROUP"]}

Types

PrivacyCategoryConfig

Fields

Example

{
  "blockAffiliate": true,
  "blockDisguisedTrackers": true,
  "blockAdsAndTrackers": true
}

Types

PrivacyCategoryConfigInput

Fields

Example

{
  "blockAffiliate": true,
  "blockDisguisedTrackers": true,
  "blockAdsAndTrackers": true
}

Types

ProtocolInput

Fields

Example

{"policy": "ALLOW_ALL", "ports": [PortRangeInput]}

Types

ProtocolPolicy

Values

Example

"ALLOW_ALL"

Types

ProtocolsInput

Fields

Example

{
  "allowIcmp": true,
  "tcp": ProtocolInput,
  "udp": ProtocolInput
}

Types

RemoteNetwork

Fields

Example

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-15T00:00:00.000Z",
  "name": "Example Name",
  "id": "YWJjMTIzeHl6Nzg5",
  "networkType": "REGULAR",
  "location": "AWS",
  "isActive": true,
  "resources": ResourceConnection,
  "connectors": ConnectorConnection,
  "gateways": GatewayConnection
}

Types

RemoteNetworkConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [RemoteNetworkEdge],
  "totalCount": 10
}

Types

RemoteNetworkCreateMutation

Fields

Example

{"ok": true, "error": "example", "entity": RemoteNetwork}

Types

RemoteNetworkDeleteMutation

Fields

Example

{"ok": true, "error": "example"}

Types

RemoteNetworkEdge

Description

A Relay edge containing a RemoteNetwork and its cursor.

Fields

Example

{"node": RemoteNetwork, "cursor": "example"}

Types

RemoteNetworkFilterInput

Fields

Example

{
  "name": StringFilterOperatorInput,
  "networkType": RemoteNetworkTypeFilterOperatorInput
}

Types

RemoteNetworkIdFilterOperationInput

Description

Filter input object for a RemoteNetwork ID field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["abc123xyz789"], "eq": "abc123xyz789"}

Types

RemoteNetworkLocation

Values

Example

"AWS"

Types

RemoteNetworkType

Values

Example

"REGULAR"

Types

RemoteNetworkTypeFilterOperatorInput

Description

Filter input object for a RemoteNetworkType enum field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["REGULAR"]}

Types

RemoteNetworkUpdateMutation

Fields

Example

{"ok": true, "error": "example", "entity": RemoteNetwork}

Types

Resource

Fields

Possible Types

Example

Types

ResourceAccessAddMutation

Fields

Example

{"ok": true, "error": "example", "entity": Resource}

Types

ResourceAccessRemoveMutation

Fields

Example

{"ok": true, "error": "example", "entity": Resource}

Types

ResourceAccessSetMutation

Fields

Example

{"ok": true, "error": "example", "entity": Resource}

Types

ResourceAddress

Fields

Example

{"type": "IP", "value": "example"}

Types

ResourceConnection

Fields

Example

{
  "pageInfo": PageInfo,
  "edges": [ResourceEdge],
  "totalCount": 10
}

Types

ResourceCreateMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "entity": NetworkResource
}

Types

ResourceDeleteMutation

Fields

Example

{"ok": true, "error": "example"}

Types

ResourceEdge

Description

A Relay edge containing a Resource and its cursor.

Fields

Example

{"node": Resource, "cursor": "example"}

Types

ResourceFilterInput

Fields

Example

{
  "name": StringFilterOperatorInput,
  "remoteNetworkId": RemoteNetworkIdFilterOperationInput,
  "tags": TagsFilterOperatorInput
}

Types

ResourceIdFilterOperationInput

Description

Filter input object for a Resource ID field. Each field of this input object represents a filtering operation. When multiple fields are specified, they are combined with an AND operation.

Fields

Example

{"in": ["abc123xyz789"]}

Types

ResourceProtocol

Fields

Example

{"policy": "ALLOW_ALL", "ports": [PortRange]}

Types

ResourceProtocols

Fields

Example

{
  "allowIcmp": true,
  "tcp": ResourceProtocol,
  "udp": ResourceProtocol
}

Types

ResourceUpdateMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "entity": NetworkResource
}

Types

RoutingMode

Values

Example

"THROUGH_TWINGATE"

Types

SSHCertificateAuthority

Fields

Example

{"id": "YWJjMTIzeHl6Nzg5", "name": "Example Name", "fingerprint": "example"}

Types

SSHCertificateAuthorityCreateMutation

Fields

Example

{
  "ok": true,
  "error": "example",
  "entity": SSHCertificateAuthority
}

Types

SSHCertificateAuthorityDeleteMutation

Fields

Example

{"ok": true, "error": "example"}

Types

SSHDownstreamInput

Fields

Example

{"port": 443}

Types

SSHResource

Fields

Example

Types

SSHResourceCreateMutation

Fields

Example

{"ok": true, "error": "example", "entity": SSHResource}

Types

SSHResourceDownstream

Fields

Example

{"port": 443}

Types

SSHResourceUpdateMutation

Fields

Example

{"ok": true, "error": "example", "entity": SSHResource}

Types

SSHResourceUpstream

Fields

Example

{"port": 443}

Types

SSHUpstreamInput

Fields

Example

{"port": 443}

Types

SecurityCategoryConfig

Fields

Example

{
  "enableThreatIntelligenceFeeds": true,
  "enableGoogleSafeBrowsing": true,
  "blockCryptojacking": true,
  "blockIdnHomographs": true,
  "blockTyposquatting": true,
  "blockDnsRebinding": true,
  "blockNewlyRegisteredDomains": true,
  "blockDomainGenerationAlgorithms": true,
  "blockParkedDomains": true
}

Types

SecurityCategoryConfigInput

Fields

Example

Types

SecurityPolicy

Fields