Skip to content

SSO LDAP, OIDC, SAML, Social #6334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 18 commits into
base: master
Choose a base branch
from
Draft

SSO LDAP, OIDC, SAML, Social #6334

wants to merge 18 commits into from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Apr 23, 2025

User description

Preview Link

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors


PR Type

Documentation


Description

  • Added new documentation pages for SSO integration methods.

  • Introduced menu entries for SSO with Social IDP, OIDC, SAML, and LDAP.

  • Updated the menu structure to categorize Identity Management as a directory.

  • Provided consistent metadata for new SSO documentation pages.


Changes walkthrough 📝

Relevant files
Documentation
single-sign-on-ldap.md
Add documentation page for SSO with LDAP                                 

tyk-docs/content/api-management/single-sign-on-ldap.md

  • Created a new documentation page for SSO with LDAP.
  • Added metadata including title, tags, description, and keywords.
  • +7/-0     
    single-sign-on-oidc.md
    Add documentation page for SSO with OIDC                                 

    tyk-docs/content/api-management/single-sign-on-oidc.md

  • Created a new documentation page for SSO with OpenID Connect (OIDC).
  • Included metadata such as title, tags, description, and keywords.
  • +7/-0     
    single-sign-on-saml.md
    Add documentation page for SSO with SAML                                 

    tyk-docs/content/api-management/single-sign-on-saml.md

  • Added a new documentation page for SSO with SAML.
  • Provided consistent metadata: title, tags, description, keywords.
  • +7/-0     
    single-sign-on-social-idp.md
    Add documentation page for SSO with Social IDP                     

    tyk-docs/content/api-management/single-sign-on-social-idp.md

  • Introduced a new documentation page for SSO with Social IDPs.
  • Included metadata for discoverability and consistency.
  • +7/-0     
    menu.yaml
    Update menu structure for SSO documentation pages               

    tyk-docs/data/menu.yaml

  • Updated menu to make Identity Management a directory.
  • Added submenu entries for SSO with Social IDP, OIDC, SAML, and LDAP.
  • Linked new documentation pages to the menu.
  • +18/-1   

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @sharadregoti sharadregoti marked this pull request as draft April 23, 2025 10:21
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Metadata Consistency

    The metadata fields such as title, tags, and keywords are identical across all new SSO documentation pages. Review if this is intentional or if each page should have more specific metadata for clarity and SEO.

    ---
    title: "Tyk Identity Broker - Integrate Social Logins, IDPs, LDAP and Custom Authentication"
    date: 2025-01-10
    tags: ["Tyk Identity Broker", "TIB", "Identity Provider", "Identity Handler", "SSO", "Custom Authentication", "Custom Proxy Provder", "SAML", "OIDC", "OpenID Connect", "Profies", "IDPs", "Social Provider" ,"LDAP"]
    description: "Learn how to integrate external services with Tyk API Gateway. Discover how to use middleware plugins, webhooks, and service discovery to extend your API functionality and connect with third-party systems."
    keywords: ["Tyk Identity Broker", "TIB", "Identity Provider", "Identity Handler", "SSO", "Custom Authentication", "Custom Proxy Provder", "SAML", "OIDC", "OpenID Connect", "Profies", "IDPs", "Social Provider" ,"LDAP"]
    ---
    Menu Structure Update

    The menu structure now categorizes Identity Management as a directory and adds new SSO pages. Ensure that the new structure does not break navigation or introduce duplicate/conflicting paths.

    category: Directory
    show: True
    menu:
    - title: "SSO with Social IDP"
      path: /api-management/single-sign-on-social-idp
      category: Page
      show: True
    - title: "SSO with OpenID Connect"
      path: /api-management/single-sign-on-oidc
      category: Page
      show: True
    - title: "SSO with SAML"
      path: /api-management/single-sign-on-saml
      category: Page
      show: True
    - title: "SSO with LDAP"
      path: /api-management/single-sign-on-ldap
      category: Page
      show: True

    Copy link
    Contributor

    PR Code Suggestions ✨

    Copy link

    netlify bot commented Apr 23, 2025

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit bc44240
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6808bf355f786200096e6a04
    😎 Deploy Preview https://deploy-preview-6334--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant