How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
SmallStep

SmallStep Credentials API

Manage credentials

Documentation Provider Profile APIs.io OpenAPI GitHub

SmallStep Credentials API is one of 6 APIs that SmallStep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 2 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2025-01-01.

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

5 operations 2 paths 20 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-01-01
Base URL
https://gateway.smallstep.com/api
Authentication
HTTP Bearer, Mutual TLS
Contact
Smallstep Support
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

SmallStep Credentials API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT). It requires mutual TLS (mtls). By default, every request must be authenticated.

  • mtls — Use a client certificate issued by a trusted root to get short-lived bearer tokens with the step CLI.

Paths & Operations 5

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

Credentials 5

Manage credentials

DELETE
/credential/{credentialID}
Delete Credential
DeleteCredential 4 params → 204400401500
GET
/credential/{credentialID}
Get Credential
GetCredential 4 params → 200400401404500
PUT
/credential/{credentialID}
Put Credential
PutCredential 4 params body → 200400401404500
GET
/credentials
List Credentials
ListCredentials 4 params → 200400401403500
POST
/credentials
Create Credential
PostCredentials 3 params body → 201400401500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are x509Fields (15 properties), credentialFiles (7 properties), credential (7 properties), x509Names (5 properties). Each schema is shown below with its type and property counts.

policyMatchCriteria
object
Policy to select the devices an account is assigned to. An empty policy indicates an account will be provisioned for all devices.
5 properties
certificateFieldList
object
A certificate field that accepts multiple string values, e.g. SANs.
3 properties
x509CustomExtension
object
An arbitrary X.509 certificate extension.
3 properties 2 required
deviceAssurance
string
The assurance level of the device. High-assurance devices are those that have a user binding, have been approved, and have performed cryptographic remote attes…
x509Fields
object
Populate certificate fields using using static names or device metadata.
15 properties
deviceOS
string
The device operating system. This field may be populated with a value derived from data synced from your team's MDMs. Setting this value explicitly will mask a…
deviceOwnership
string
Whether the device is owned by the user or the company. This field may be populated with a value derived from data synced from your team's MDMs. Setting this v…
x509NamePolicy
object
Allow- and deny-lists constraining the X.509 names a credential's provisioner may issue. When omitted, no name policy is enforced. On update, omitting this fie…
3 properties
endpointManagementMode
string
Determines who manages the certificate lifecycle for the workload. Defaults to agent if not set. - agent: The Smallstep Agent manages the certificate lifecycle…
credentialFiles
object
Configuration for files that will be written when a managed credential is issued.
7 properties
error
object
1 property 1 required
x509TypedSANs
object
Explicitly typed subject alternative names. When set, takes precedence over the untyped sans field.
5 properties
x509ExtendedKeyUsage
string
A purpose for which a certified public key may be used.
credentialCertificate
object
Configuration for the certificate of a managed credential.
5 properties 3 required
credential
object
A certificate key pair.
7 properties 4 required
x509Names
object
A set of X.509 name patterns grouped by name type.
5 properties
certificateField
object
A certificate field that takes a single string value, e.g. Common Name. Static values are used as a fallback when device metadata is not present.
2 properties
deviceDiscoverySource
string
The source from which this device was discovered.
credentialKey
object
The attributes of the cryptographic key. Key type and protection are required unless the pubFile is set.
3 properties
sshFields
object
Populate certificate fields using static names or device metadata.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smallstep-credentials-api-openapi.yml Raw ↑

Other APIs SmallStep publishes across the network.

SmallStep Authentication API
AE Profile APIs.io
SmallStep Certificates API
AE Profile APIs.io
SmallStep Device Inventory API
AE Profile APIs.io
SmallStep PKI Architecture API
AE Profile APIs.io
SmallStep Protect API
AE Profile APIs.io
#Credentials
← Back to S APIs
API Details
ID
smallstep:smallstep-credentials-api
Base URL
https://gateway.smallstep.com/api
Docs
https://smallstep.com/docs/platform/smallstep-api/
Provider
SmallStep
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=smallstep-credentials-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/smallstep-credentials-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of SmallStep Credentials API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.