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

Emissary-Ingress AuthService API

Operations for managing AuthService custom resources that configure external authentication and authorization services. Emissary-Ingress will call the configured auth service before forwarding requests to upstream services.

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

This API exposes 1 JSON Schema definition.

Tagged areas include AuthService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, authentication docs, and 1 JSON Schema.

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 3.9.0.

Requests are made against a single base URL, https://{kubernetes-api-server}.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.9.0
Server
https://{kubernetes-api-server}
License
Resource Areas
1

Paths & Operations 2

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

AuthService 2

Operations for managing AuthService custom resources that configure external authentication and authorization services. Emissary-Ingress will call the configured auth service befo…

GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/authservices
Emissary-Ingress List AuthService resources in a namespace
listNamespacedAuthService 4 params → 200401403
POST
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/authservices
Emissary-Ingress Create an AuthService resource
createNamespacedAuthService 1 param body → 201400401403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AuthServiceSpec (9 properties), ObjectMeta (8 properties), AuthServiceList (4 properties), AuthService (4 properties). Each schema is shown below with its type and property counts.

AuthServiceSpec
object
Specification for the AuthService.
9 properties 1 required
ObjectMeta
object
Standard Kubernetes object metadata.
8 properties 1 required
AuthService
object
Emissary-Ingress AuthService custom resource configuring an external authentication and authorization service. Before forwarding a request to the upstream serv…
4 properties 4 required
AuthServiceList
object
List of AuthService resources.
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emissary-ingress-authservice-api-openapi.yml Raw ↑

Other APIs Emissary-Ingress publishes across the network.

Emissary-Ingress Gateway API
Emissary-Ingress Host API
Emissary-Ingress Mapping API
Emissary-Ingress RateLimitService API
Emissary-Ingress TLSContext API