Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TetraScience Access Groups API

The Access Groups API from TetraScience — 6 operation(s) for access groups.

TetraScience Access Groups API is one of 35 APIs that TetraScience publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Access Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and authentication docs.

This API exposes 9 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against 5 base URLs: https://api.tetrascience.com, https://api.tetrascience-uat.com, https://api.tetrascience-dev.com, https://api.tetrascience-uat.com, api.tetrascience.com.

9 operations 6 paths 22 schemas 2 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api.tetrascience.com
Authentication
API Key, API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 3

TetraScience Access Groups API declares 3 security schemes for authenticating requests. An API key is passed in the header as ts-auth-token (token). An API key is passed in the header as x-org-slug (orgSlug). An API key is passed in the header as ts-auth-token (tsAuthToken). By default, every request must be authenticated.

  • token — JWT Token for authentication
  • orgSlug — Your organization slug

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Access Groups 9
DELETE
/v1/accessGroups/{id}
Delete an Access Group
1 param → 204
GET
/v1/accessGroups/{id}
Get Access Group Details
1 param → 200
PUT
/v1/accessGroups/{id}
Edit an Access Group
1 param body → 200
DELETE
/v1/accessGroups/{id}/user/{userId}
Remove a User from an Access Group
2 params → 204
GET
/v1/accessGroups
List Access Groups for an Organization
→ 200
POST
/v1/accessGroups
Create a New Access Group
body → 201
GET
/v1/accessGroups/user/{id}
List Access Groups that a User Belongs To
1 param → 200
POST
/v1/accessGroups/{id}/user
Add a User to an Access Group
1 param body → 201
POST
/v1/accessGroups/{id}/users
Add or Remove Users from an Access Group
1 param body → 201

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are AccessGroup (9 properties), FilterTagConfig (5 properties), FilterMetadatumConfig (5 properties), CreateUpdateAccessGroup (5 properties). Each schema is shown below with its type and property counts.

FilterLeaf
AttributeRule
object
1 property 1 required
FilterAndConfig
object
3 properties 1 required
FilterTagConfig
object
5 properties 3 required
FilterMetadatumConfig
object
5 properties 3 required
FilterAllowAllConfig
object
1 property 1 required
FilterCategoryConfig
object
4 properties 2 required
FilterSourceNameConfig
object
4 properties 2 required
CreateUpdateAccessGroup
object
5 properties 3 required
FilterPipelineConfig
object
4 properties 2 required
AccessGroup
object
9 properties 6 required
FilterSourceTypeConfig
object
4 properties 2 required
FilterOrConfig
object
3 properties 1 required
FilterIDSConfig
object
4 properties 2 required
FilterFilePathConfig
object
4 properties 2 required
FilterIDSTypeConfig
object
4 properties 2 required
FilterCreatedAtConfig
object
4 properties 2 required
FilterTagNameConfig
object
4 properties 2 required
AccessGroupSummary
object
3 properties 2 required
FilterConfig
AttributeRuleConfiguration
object
FilterLabelConfig
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrascience-access-groups-api-openapi.yml Raw ↑

Other APIs TetraScience publishes across the network.

TetraScience Agents API
TetraScience ai-workflows API
TetraScience Attributes API
TetraScience Audit Trail API
TetraScience clusters API
TetraScience Commands API
TetraScience Connectors API
TetraScience Data Acquisition API
TetraScience Data App Providers API
TetraScience Data Apps API
TetraScience databricks API
TetraScience Edit Subscriptions API