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

Authentik SSF API

OpenID Shared Signals Framework streams — the SSF stream surface a receiving application manages on authentik as transmitter of Security Event Tokens.

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

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

This API exposes 3 operations across 2 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 2026.11.0-rc1.

Requests are made against a single base URL, /api/v3.

3 operations 2 paths 17 schemas 1 DELETE2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.11.0-rc1
Base URL
https://{authentik_host}/api/v3
Authentication
HTTP Bearer, HTTP Bearer+Agent, HTTP Bearer, HTTP Bearer
License
Resource Areas
1

Authentication & Security 4

Authentik SSF API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (authentik). It uses HTTP bearer+agent authentication (authentik_device_auth). It accepts HTTP bearer tokens (authentik_device_enroll). It accepts HTTP bearer tokens (authentik_device_federation).

Paths & Operations 3

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

ssf 3
GET
/ssf/streams/
SSFStream Viewset
ssf_streams_list 7 params → 200400403
GET
/ssf/streams/{uuid}/
SSFStream Viewset
ssf_streams_retrieve 1 param → 200400403
DELETE
/ssf/streams/{uuid}/
SSFStream Viewset
ssf_streams_destroy 1 param → 204400403

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are User (20 properties), Provider (14 properties), SSFProvider (13 properties), SSFStream (10 properties). Each schema is shown below with its type and property counts.

SSFStream
object
SSFStream Serializer
10 properties 6 required
Token
object
Token Serializer
9 properties 3 required
Role
object
Role serializer
2 properties 2 required
SSFProvider
object
SSFProvider Serializer
13 properties 10 required
Provider
object
Provider Serializer
14 properties 10 required
EventsRequestedEnum
string
Pagination
object
7 properties 7 required
IntentEnum
string
UserTypeEnum
string
User
object
User Serializer
20 properties 12 required
ValidationError
object
Validation Error
2 properties
PaginatedSSFStreamList
object
3 properties 3 required
SSFStreamStatusEnum
string
Autocomplete
object
DeliveryMethodEnum
string
PartialGroup
object
Partial Group Serializer, does not include child relations.
5 properties 3 required
GenericError
object
Generic API Error
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

authentik-ssf-api-openapi.yml Raw ↑

Other APIs Authentik publishes across the network.

Authentik Core API
Authentik Crypto API
Authentik Events API
Authentik Flows API
Authentik Policies API
Authentik Providers API
Authentik RBAC API
Authentik Schema API
Authentik Sources API
Authentik Stages API
Authentik Admin API
Authentik Agents API
Where this information came from

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