Skip to content

Trustgrid Management API (1.0.0)

Download OpenAPI description
index.json
index.yaml
Overview
License
unlicensed
Languages
Servers
Mock server
https://apidocs.trustgrid.io/_mock
https://api.trustgrid.io

Alarm

Alarm filters manage criteria and thresholds for what events generate alerts.

Operations

Alert

Operations

Agent

Agents run on consumer devices and have a subset of appliance functionality

Operations

Appliance

Appliances are Trustgrid nodes deployed either physically or as a virtual machine.

Operations

Certificate

TLS certificates

Operations

Cluster

Clusters allow shared config and HA

Operations

Domain

A domain provides a logical grouping of nodes inside an organization.

Operations

Tag

Tags allow grouping clusters and nodes for permissions and reporting.

Operations

Upgrade Manager

Nodes can be upgraded in bulk using the upgrade manager.

Operations

Virtual Network

Virtual network configuration

Operations

Compute

Edge compute configuration

Operations

Repository

Container repository

Operations

Audit

Audits are logged to keep track of user and system changes. Trustgrid exposes authentication audits, configuration changes, and flow logs

Operations

Group

Groups allow exposing ZTNA applications to users.

Operations

IDP

Identity provider configuration

Operations

Org

Org-related APIs expose support requests, support settings, and shared documents.

Operations

Order

Provision process management

Operations

Permissions

Permissions management

Operations

ServiceUser

Users who only have API access

Operations

User

All interactions with the Trustgrid API require a user.

Operations

Send an invitation email to a new user to join the organization

Request

For organizations using the default Trustgrid authentication provider, users must be invited and then they should sign up with the invited email address. For custom IDP integrations, users should be added instead.

Security
JWTAuthorizer
Bodyapplication/json
emailstringrequired

User's email

policyIdstringrequired

ID of the policy to be applied to the user upon account creation

curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/user \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "policyId": "string"
  }'

Responses

OK

Directly add a user account for organizations with custom identity providers

Request

Add a user. This is only available to organizations with custom IDP integrations.

Security
JWTAuthorizer
Bodyapplication/json
emailstringrequired

User's email

idpstringrequired

ID of the IDP to be used for the user

policyIdsArray of stringsrequired

IDs of the policy/policies to be applied to the user

curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/user/add \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "idp": "string",
    "policyIds": [
      "string"
    ]
  }'

Responses

OK

Permanently remove a user from the organization and revoke all access

Request

Security
JWTAuthorizer
Path
emailstringrequired

User email

curl -i -X DELETE \
  'https://apidocs.trustgrid.io/_mock/user/{email}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Response
No content