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

AGNTCY Settings Service API

SettingsService manages settings.

AGNTCY Settings Service API is one of 21 APIs that AGNTCY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

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

This API exposes 3 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v1alpha1.

Requests are made against a single base URL, http://localhost:4000.

3 operations 3 paths 12 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1alpha1
Base URL
https://schema.oasf.outshift.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

AGNTCY Settings Service API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (AccessToken). An API key is passed in the header as x-id-api-key (ApiKey). By default, every request must be authenticated.

  • AccessToken — An IAM JWT token issued to a user during an OIDC flow.
  • ApiKey — An IAM Api key.

Paths & Operations 3

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

SettingsService 3

SettingsService manages settings.

GET
/v1alpha1/settings
Get Settings
SettingsService_GetSettings → 200default
POST
/v1alpha1/settings/api-key
Set up API Key
SettingsService_SetApiKey → 200default
POST
/v1alpha1/settings/issuer
Set up Issuer
SettingsService_SetIssuer body → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are IssuerSettings (10 properties), PingIdpSettings (4 properties), KeycloakIdpSettings (4 properties), OktaIdpSettings (3 properties). Each schema is shown below with its type and property counts.

DuoIdpSettings
object
Duo IdP Settings
3 properties
Settings
object
Identity Settings
2 properties
PingIdpSettings
object
Ping IdP Settings
4 properties
EntraIdpSettings
object
Entra ID (Azure AD) IdP Settings
3 properties
OryIdpSettings
object
Ory IdP Settings
2 properties
GoogleProtobufAny
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
1 property
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
IssuerSettings
object
Issuer Settings
10 properties 1 required
OktaIdpSettings
object
Okta IdP Settings
3 properties
ApiKey
object
An Identity API Key.
1 property
KeycloakIdpSettings
object
Keycloak IdP Settings
4 properties
SetIssuerRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

agntcy-settingsservice-api-openapi.yml Raw ↑

Other APIs AGNTCY publishes across the network.

Agent Directory (DIR)
AGNTCY Agents API
AGNTCY App Service API
AGNTCY Auth Service API
AGNTCY Badge Service API
AGNTCY Classes and Objects API
AGNTCY Device Service API
AGNTCY ID Service API
AGNTCY Issuer Service API
AGNTCY JSON Schema API
AGNTCY Policy Service API
AGNTCY Sample Data API
Where this information came from

This is an independent, third-party profile of AGNTCY Settings Service 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.