{
  "opencollection": "1.0.0",
  "info": {
    "name": "Gremlin agents integration-clients API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "integration-clients",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Activates an integration client.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.gremlin.com/v1/integration-clients/:identifier/activate",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path",
                "description": "The identifier of the integration client to modify."
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "Requires the privilege [`CLIENTS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Get all active integration clients.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/integration-clients/active",
            "params": [
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "Requires the privilege [`INTEGRATIONS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns all integration clients within a company or team.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/integration-clients",
            "params": [
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "This operation will return all active, idle, and recently inactive integration clients.\nRequires the privilege [`INTEGRATIONS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns list of clients which match the given tags",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/integration-clients/matches-tags",
            "params": [
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requires the privilege [`INTEGRATIONS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Deactivates an integration client.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.gremlin.com/v1/integration-clients/:identifier",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path",
                "description": "The identifier of the integration client to modify."
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "This operation will deactivate the specified integration client. The specified client will no longer be able to be used as a target.\nRequires the privilege [`CLIENTS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        }
      ]
    }
  ],
  "bundled": true
}