SwaggerHub On-premise 2.x
SwaggerHub On-premise 2.x is a powerful and versatile platform that can assist organizations in designing, developing, documenting, and deploying APIs. It is a suitable option for organizations needing a self-hosted API development platform that is scalable, reliable, and secure.
Key Features of SwaggerHub On-Premise 2.x
- Self-hosted deployment: Can be deployed on-premises on any Kubernetes-compatible infrastructure.
- High availability.
- Scalability.
- Security.
- Support for Open API Specification and Async API: Supports both Open API Specification (OAS) and Async API, making it a versatile platform for a wide range of API use cases.
Microsoft Entra
Microsoft Entra is a good option for organizations needing a comprehensive Identity Access Management (IAM) solution that can help them protect their data and resources. It is a scalable and secure platform that can meet the needs of organizations of all sizes.
Microsoft Entra Features:
- Microsoft Entra Identity governance
- Authentication: Supports a variety of authentication methods, including password-based authentication, multi-factor authentication, and federated authentication.
- Authorization: Provides role-based access control (RBAC) and attribute-based access control (ABAC) to control access to resources.
- Provisioning: Automates the creation and management of user accounts.
- Access management
- Single sign-on (SSO): Allows users to sign in to multiple applications with a single set of credentials.
- Privileged access management (PAM): Provides a secure way to manage access to sensitive resources.
- Data loss prevention (DLP): Helps organizations protect sensitive data from unauthorized access.
- Risk management
- Identity risk management (IRM): Helps organizations identify and mitigate security risks associated with identities.
- Access risk management (ARM): Helps organizations identify and mitigate security risks associated with access to resources.
Configuring Microsoft Entra in SwaggerHub On-premise 2.x
Steps to configure Azure AD/MicroSoft Entra
1. Click on Enterprise application in your Entra/AD account.
2. Click on new application and select Create your own application.
3. Select the third option ‘Integrate any other application you don’t find in gallery(Non-gallery)’ and provide the input name.
4. Select the option ‘Set up Single Sign On’ in the application overview page.
5. Select the option SAML.
6. Configure the SAML using SwaggerHub On-premise details.
Entity ID – https:///login/callback
Reply URL – https:///login/callback
7. Save the configuration.
8. Download the base64 Certificate and copy the Login URL (needs to be configured in SwaggerHub Admin Centre).
9. Add required user groups and users to the newly created Enterprise Application to grant access to SwaggerHub.
Steps to configure SwaggerHub Admin Centre
- Open the SwaggerHub Admin Centre.
- Open the configuration details and select the option Authentication as SAML.
- Provide the SAML Identity provider URL as:
- https///login/callback.
- Provide the SAML identity Provider URL as the Login URL copied from Microsoft Entra.
- Upload the Base 64 certificate downloaded from the Microsoft Entra to the placeholder ‘SAML identity provider certificate’.
- Click on Save and Deploy the configuration.
Post Deployment
Log in to the SwaggerHub. (Sign up option won’t be available, and the new user can be added into the Microsoft Entra Application)
You can now use your windows credentials to login to your SwaggerHub as any other Microsoft app.
Conclusion
SwaggerHub supports single sign-on (SSO) using a variety of identity providers (IdPs), including Okta (SAML 2.0), Active Directory, OpenLDAP, and GitHub. This means that you can use your existing IdP to authenticate users in SwaggerHub, without having to create and manage separate user accounts. Discover the capabilities of SwaggerHub on-premise, your go-to self-hosted API Development Platform. Elevate your API management with advanced features for seamless development and deployment for Microsoft Entra to benefit from reduction of development wait times by 90%.
