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

SPIFFE Workload API

The SPIFFE Workload API is a gRPC streaming interface through which workloads request and receive SPIFFE Verifiable Identity Documents (SVIDs) including X.509-SVIDs and JWT-SVIDs, as well as trust bundle updates. It enables software to obtain cryptographic identities at runtime without requiring secrets to be embedded in configuration or code.

SPIFFE Workload API is one of 4 APIs that SPIFFE publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include gRPC, Identity, JWT, Workload, and X.509. The published artifact set on APIs.io includes API documentation, an API reference, an AsyncAPI specification, and a GitHub repository.

This event API exposes 5 operations across 5 channels, and defines 12 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, unix:///tmp/spire-agent/public/api.sock (grpc).

5 operations 5 channels 12 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Server
unix:///tmp/spire-agent/public/api.sock (grpc)
Resource Areas
1

Channels & Operations 5

Across 5 channels, the API surfaces 5 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 5
SUB
/spiffe.workload.SpiffeWorkloadAPI/FetchX509SVID
Stream X.509 SVID updates
fetchX509SVID body
SUB
/spiffe.workload.SpiffeWorkloadAPI/FetchX509Bundles
Stream X.509 trust bundle updates
fetchX509Bundles body
SUB
/spiffe.workload.SpiffeWorkloadAPI/FetchJWTSVID
Receive a JWT-SVID
fetchJWTSVID body
SUB
/spiffe.workload.SpiffeWorkloadAPI/FetchJWTBundles
Stream JWT trust bundle updates
fetchJWTBundles body
SUB
/spiffe.workload.SpiffeWorkloadAPI/ValidateJWTSVID
Receive JWT-SVID validation result
validateJWTSVID body

Messages & Schemas 12

The contract defines 12 schemas that model the data carried by its messages. The most detailed are X509SVID (5 properties), JWTSVID (3 properties), X509SVIDResponse (2 properties), ValidateJWTSVIDResponse (2 properties). Each schema is shown below with its type and property counts.

X509SVIDResponse
message
A batch of X.509-SVIDs for the workload
X509BundlesResponse
message
The complete set of X.509 trust bundles
JWTSVIDResponse
message
One or more JWT-SVIDs for the requested audience
JWTBundlesResponse
message
JWT trust bundles for all trust domains
ValidateJWTSVIDResponse
message
Result of JWT-SVID validation
X509SVID
object
An X.509-SVID (SPIFFE Verifiable Identity Document) consisting of an X.509 certificate chain with the SPIFFE ID encoded in the Subject Alternative Name URI fie…
5 properties 4 required
X509SVIDResponse
object
Streamed response from the FetchX509SVID RPC containing all X.509-SVIDs the workload is authorized to hold. Workloads should replace their entire current SVID…
2 properties 1 required
X509BundlesResponse
object
Streamed response from the FetchX509Bundles RPC containing X.509 trust bundles for all trust domains.
1 property 1 required
JWTSVID
object
A JWT-SVID (SPIFFE Verifiable Identity Document) encoded as a signed JSON Web Token. The SPIFFE ID is the subject ("sub") claim and the audience is specified i…
3 properties 2 required
JWTSVIDResponse
object
Response from the FetchJWTSVID RPC containing JWT-SVIDs
1 property 1 required
JWTBundlesResponse
object
Streamed response from the FetchJWTBundles RPC containing JWT signing key sets for all trust domains.
1 property 1 required
ValidateJWTSVIDResponse
object
Response from the ValidateJWTSVID RPC
2 properties 1 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

spiffe-workload-asyncapi.yml Raw ↑

Other APIs SPIFFE publishes across the network.

SPIFFE X.509 SVID
SPIFFE JWT SVID
SPIFFE Bundle API
Where this information came from

This is an independent, third-party profile of SPIFFE Workload 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.