openapi: 3.1.0
info:
  title: OpenID Connect (OIDC) SSO Authentication Metadata API
  description: The OpenID Connect (OIDC) API is a lightweight identity layer built on top of OAuth 2.0 that enables applications to verify user identity and obtain basic profile information. OIDC defines standard endpoints including the Authorization Endpoint, Token Endpoint, UserInfo Endpoint, and JWKS URI. It supports Authorization Code Flow, Implicit Flow, Hybrid Flow, and PKCE extensions for public clients. OIDC is widely implemented by identity providers including Okta, Microsoft Entra ID, Google, Auth0, and Keycloak.
  version: '1.0'
  contact:
    name: OpenID Foundation
    url: https://openid.net/connect/
  termsOfService: https://openid.net/connect/
servers:
- url: https://your-idp.example.com
  description: OpenID Provider (OP) Server
tags:
- name: Metadata
  description: SAML 2.0 metadata endpoints for exchanging federation configuration between identity providers and service providers.
paths:
  /saml/metadata:
    get:
      operationId: getSAMLMetadata
      summary: Get SAML Metadata
      description: Returns the SAML 2.0 metadata XML document for this identity provider or service provider. The metadata document contains entity ID, SSO binding endpoints, certificate for signature verification, and supported NameID formats required for federation configuration.
      tags:
      - Metadata
      responses:
        '200':
          description: SAML 2.0 metadata XML document
          content:
            application/samlmetadata+xml:
              schema:
                type: string
                description: SAML 2.0 EntityDescriptor XML metadata document
            application/xml:
              schema:
                type: string
                description: SAML 2.0 EntityDescriptor XML metadata document
        '404':
          description: Metadata not available
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 Bearer access token in Authorization header
externalDocs:
  description: OpenID Connect Specification
  url: https://openid.net/connect/