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

The San Francisco Compute Company Users API

Read-only access to users within the caller's organization.

The San Francisco Compute Company Users API is one of 14 APIs that The San Francisco Compute Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.sfcompute.com.

2 operations 2 paths 13 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.sfcompute.com/preview/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

The San Francisco Compute Company Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth). By default, every request must be authenticated.

  • bearer_auth — Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Paths & Operations 2

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

Users 2

Read-only access to users within the caller's organization.

GET
/preview/v2/users
List users
list_users_handler 5 params → 200401403422500
GET
/preview/v2/users/{id}
Get user
get_user_handler 1 param → 200401403404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are UserResponse (7 properties), ListUsersResponse (4 properties), ErrorDetail (3 properties), UnauthorizedError (1 property). Each schema is shown below with its type and property counts.

userResourcePath_UserId
string
A resource path for a user resource. Format: sfc:user: .
UsersCursor
string
InternalServerError
object
1 property 1 required
UserId
string
NotFoundError
object
1 property 1 required
ResourcePathOrId_UserId
string
A resource path like 'sfc:user:my-user' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are s…
ListUsersResponse
object
4 properties 3 required
UnprocessableEntityError
object
1 property 1 required
UnixEpoch
integer
Unix timestamp.
UserResponse
object
7 properties 4 required
UnauthorizedError
object
1 property 1 required
ErrorDetail
object
3 properties 2 required
ForbiddenError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-users-api-openapi.yml Raw ↑

Other APIs The San Francisco Compute Company publishes across the network.

The San Francisco Compute Company Account API
The San Francisco Compute Company Deployments API
The San Francisco Compute Company Feature Flags API
The San Francisco Compute Company Images API
The San Francisco Compute Company Instance SKU Catalog API
The San Francisco Compute Company Instance SKUs API
The San Francisco Compute Company Instance Templates API
The San Francisco Compute Company Instances API
The San Francisco Compute Company Orderbook API
The San Francisco Compute Company Orders API
The San Francisco Compute Company Pools API
The San Francisco Compute Company Procurements API