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

Hatchet User API

The User API from Hatchet — 12 operation(s) for user.

Hatchet User API is one of 27 APIs that Hatchet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, code examples, authentication docs, and 12 JSON Schemas.

This API exposes 12 operations across 12 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against the base URL https://api.hatchet-cloud.run.

12 operations 12 paths 15 schemas 8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.hatchet-cloud.run
Authentication
HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Hatchet User API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as hatchet (cookieAuth). It accepts HTTP bearer tokens (customAuth). By default, every request must be authenticated.

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 8 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

User 12
POST
/api/v1/users/login
Login User
user:update:login body → 200400401405422
GET
/api/v1/users/google/start
Start Oauth Flow
user:update:google-oauth-start → 302
GET
/api/v1/users/google/callback
Complete Oauth Flow
user:update:google-oauth-callback → 302
GET
/api/v1/users/github/start
Start Oauth Flow
user:update:github-oauth-start → 302
GET
/api/v1/users/github/callback
Complete Oauth Flow
user:update:github-oauth-callback → 302
GET
/api/v1/tenants/{tenant}/slack/start
Start Oauth Flow
user:update:slack-oauth-start 1 param → 302
GET
/api/v1/users/slack/callback
Complete Oauth Flow
user:update:slack-oauth-callback → 302
GET
/api/v1/users/current
Get Current User
user:get:current → 200400401405
POST
/api/v1/users/password
Change User Password
user:update:password body → 200400401405422
POST
/api/v1/users/register
Register User
user:create body → 200400401405422
POST
/api/v1/users/logout
Logout User
user:update:logout → 200400401405
GET
/api/v1/users/memberships
List Tenant Memberships
tenant-memberships:list → 200400403

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Tenant (9 properties), User (6 properties), TenantMember (4 properties), APIError (4 properties). Each schema is shown below with its type and property counts.

PaginationResponse
object
3 properties
TenantVersion
string
UserTenantMembershipsList
object
2 properties
UserChangePasswordRequest
object
2 properties 2 required
TenantMember
object
4 properties 3 required
TenantEnvironment
string
TenantMemberRole
string
Tenant
object
9 properties 4 required
APIResourceMeta
object
3 properties 3 required
UserRegisterRequest
object
3 properties 3 required
User
object
6 properties 3 required
UserLoginRequest
object
2 properties 2 required
APIErrors
object
1 property 1 required
UserTenantPublic
object
2 properties 1 required
APIError
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-user-api-openapi.yml Raw ↑

Other APIs Hatchet publishes across the network.

Hatchet API Token API
Hatchet CEL API
Hatchet Durable Tasks API
Hatchet Event API
Hatchet Feature Flags API
Hatchet Filter API
Hatchet Github API
Hatchet Healthcheck API
Hatchet Log API
Hatchet Metadata API
Hatchet Monitoring API
Hatchet Observability API