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

Estuary Auth API

The Auth API from Estuary — 5 operation(s) for auth.

Estuary Auth API is one of 8 APIs that Estuary publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Auth. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.estuary.dev.

6 operations 5 paths 5 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.estuary.dev
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Estuary Auth API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Access token obtained from /rpc/generateaccesstoken by exchanging a refresh token. Sent as Authorization: Bearer .

Paths & Operations 6

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

Auth 6
POST
/rpc/generate_access_token
Exchange a refresh token for a short-lived access token.
generateAccessToken body → 200401
GET
/refresh_tokens
List refresh tokens for the authenticated user.
listRefreshTokens → 200
POST
/refresh_tokens
Create a new long-lived refresh token.
createRefreshToken body → 201
DELETE
/refresh_tokens/{id}
Revoke a refresh token.
deleteRefreshToken 1 param → 204
GET
/user_grants
List capability grants from users to catalog prefixes.
listUserGrants → 200
GET
/role_grants
List capability grants between catalog prefixes (roles).
listRoleGrants → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RefreshToken (5 properties), Grant (4 properties), RefreshTokenCreate (3 properties), AccessToken (2 properties). Each schema is shown below with its type and property counts.

RefreshToken
object
5 properties
GenerateAccessTokenRequest
object
1 property 1 required
Grant
object
4 properties
RefreshTokenCreate
object
3 properties
AccessToken
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

estuary-auth-api-openapi.yml Raw ↑

Other APIs Estuary publishes across the network.

Estuary Captures API
Estuary Collections API
Estuary Connectors API
Estuary Drafts API
Estuary Materializations API
Estuary Publications API
Estuary Tenants API