External IdP Support for Portal Consumers
Swagger Studio supports external identity provider (IdP) integration for Swagger Portal consumers. It allows customers to use their own IdP to authenticate external users and grant them view-only access to the organization's Portal resources. This enhancement improves access flexibility, strengthens security, and simplifies the sign-in experience for external audiences.
Configure external IdP for Portal consumers
You can add external Portal consumers in your organization's Permissions page. Enable this option by setting up an external identity provider first to ensure secure authentication for the users.
Configure an external IdP by following these steps:
Click Organization Settings on the sidebar.
Select the Permissions tab.
Navigate to the Portal IdP Consumers tab.
Click Create IdP Configuration.
Follow the onscreen guidance to set up the external IdP. Refer to Configuring Portal External IdP Connection guide for details.
Provide the required JWT token settings.
Save the configuration.
The Portal Consumers tab is enabled, allowing you to add and manage Portal consumers from the external IdP.
Important
If you cannot connect to the configured identity provider, open the IdP settings and verify the connection.
Manage external Portal consumers
Once you have set up an external IdP, you can add the users authenticated with that IdP as external Portal consumers. These users will have view-only access to your portal and cannot be granted internal organization roles.
Add external Portal consumers
To add external Portal consumers, do the following:
Click Organization Settings on the sidebar.
Select the Permissions page.
Navigate to the Portal IdP Consumers tab.
In the Add user input, enter an email address of a user authenticated with the external IdP. To invite multiple users, separate their email addresses with a space or a comma.
Click Add.
The system validates email addresses. Successfully added users appear in the Portal IdP Consumers table, while any invalid or duplicate emails are shown in an error notification below.
Delete external Portal consumers
To delete external Portal consumers and revoke their access to the Portal, do the following:
Click Organization Settings on the sidebar.
Select the Permissions page.
Navigate to the Portal Consumers tab.
Select the
delete icon at the relevant user.Click Remove member to confirm.
The selected user is removed from the Portal Consumers table.
Manage consumer roles
You can grant or restrict view-only access to a Portal product or a team for external users. A resource becomes accessible to a user once you assign them a member or consumer role in that resource.
Assign a new consumer role
To assign a role to an external user, do the following:
Click Organization Settings on the sidebar.
Select the Permissions page.
Navigate to the Portal IdP Consumers tab.
Click the
member profile icon next to the user.Click Create Role Assignment.
Select the type of resource from the Resource list.
Select the specific resource from the Name list.
Select the member's role in the specified resource from the Role list.
Click Create.
Delete a consumer role
To delete a consumer's role in a specific resource, do the following:
Click Organization Settings on the sidebar.
Select the Permissions page.
Navigate to the Portal IdP Consumers tab.
Click the
member profile icon next to the user.Select the
delete icon at the relevant resource.In the subsequent dialog, confirm your update by clicking Remove access.