Trustgrid Management API (1.0.0)

Download OpenAPI description
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

Operations

Cluster

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

Operations
Operations
Operations

KVM

Virtual machines

Operations

Repository

Container repository

Operations

Audit

Operations

Group

Groups allow exposing ZTNA applications to users.

Operations
Operations

Org

Operations

Order

Provision process management

Operations
Operations

ServiceUser

Users who only have API access

Operations

User

All interactions with the Trustgrid API require a user.

Operations

Get all users

Request

Changes to users sometimes take a few minutes to appear while being indexed

curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/user \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
emailstring

User's email

]
Response
application/json
[ { "email": "string" } ]

Invite a user to the Portal

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.

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

Add a user to the Portal

Request

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

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