OpenAPI Specification
openapi: 3.0.3
info:
title: SAML 2.0 SSO HTTP Bindings Metadata API
description: OpenAPI specification for SAML 2.0 Single Sign-On HTTP bindings as defined in the OASIS SAML 2.0 Bindings specification (saml-bindings-2.0-os). Covers the HTTP Redirect Binding and HTTP POST Binding used for AuthnRequest and Response message exchange between Service Providers and Identity Providers.
version: 1.0.0
contact:
name: Kin Lane
email: info@apievangelist.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://idp.example.com
description: SAML 2.0 Identity Provider
- url: https://sp.example.com
description: SAML 2.0 Service Provider
tags:
- name: Metadata
description: SAML 2.0 metadata retrieval.
paths:
/saml/metadata:
get:
operationId: getMetadata
summary: SAML 2.0 Metadata Endpoint
description: Returns the SAML 2.0 metadata document for the entity (Identity Provider or Service Provider) as defined in the OASIS SAML 2.0 Metadata specification (saml-metadata-2.0-os). The metadata document describes the entity's supported bindings, endpoints, certificates, and capabilities.
tags:
- Metadata
responses:
'200':
description: SAML metadata document.
content:
application/samlmetadata+xml:
schema:
type: string
description: XML document conforming to the SAML 2.0 Metadata schema containing the EntityDescriptor element.
application/xml:
schema:
type: string
description: SAML 2.0 metadata XML document.
headers:
Cache-Control:
description: Caching directives for the metadata document.
schema:
type: string
example: public, max-age=86400
'404':
description: Metadata not available for this entity.