openapi: 3.1.0
info:
  title: authentik Core Providers API
  description: 'Best-effort OpenAPI 3.1 description of the authentik identity provider''s REST

    API (v3). authentik exposes a fully OpenAPI-driven REST surface at

    /api/v3 with browsable docs at /api/v3/ on each instance and a generated

    OpenAPI schema at /api/v3/schema/. Derived from public docs at

    https://docs.goauthentik.io/developer-docs/api/.

    '
  version: '3'
  contact:
    name: authentik developer docs
    url: https://docs.goauthentik.io/developer-docs/api/
servers:
- url: https://{authentik_host}/api/v3
  description: authentik instance API root
  variables:
    authentik_host:
      default: authentik.company
      description: Hostname of your authentik deployment
security:
- tokenAuth: []
- sessionAuth: []
tags:
- name: Providers
  description: OAuth2/OIDC, SAML, LDAP, Proxy and other providers.
paths:
  /providers/all/:
    get:
      tags:
      - Providers
      summary: List providers
      operationId: providersAllList
      responses:
        '200':
          description: Providers returned
  /providers/oauth2/:
    get:
      tags:
      - Providers
      summary: List OAuth2/OIDC providers
      operationId: providersOauth2List
      responses:
        '200':
          description: OAuth2 providers returned
    post:
      tags:
      - Providers
      summary: Create OAuth2 provider
      operationId: providersOauth2Create
      responses:
        '201':
          description: OAuth2 provider created
  /providers/saml/:
    get:
      tags:
      - Providers
      summary: List SAML providers
      operationId: providersSamlList
      responses:
        '200':
          description: SAML providers returned
components:
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'authentik token authentication. Use header

        `Authorization: Bearer <token>` with a token created in the

        Tokens & App Passwords section.

        '
    sessionAuth:
      type: apiKey
      in: cookie
      name: authentik_session
      description: Browser session cookie for interactive use.