Skip to main content
Swagger
All documentation pages

Audience

Portal calls your webhook only when a member of your organization logs in. Your organization is the Swagger Studio organization that your portal belongs to. A member is a user with the Consumer, Designer, or Owner role in that organization. Learn more in Role Management.

The following users never trigger the webhook, and Portal never sends their email addresses to your webhook URL:

  • Users from other organizations.
  • Portal consumers outside your organization.
  • Anonymous visitors.
  • Visitors who log in through an external identity provider.

Try It Out Behavior

After you turn on Automatic API Authentication, members of your organization:

  • Send all Try It Out requests through the Portal proxy.
  • Receive a Bearer token only. API key and Basic authentication are currently not supported.
  • Cannot use Try It Out with APIs that are available only on a VPN or an intranet.
  • Cannot use the browser-direct routing option for Try It Out requests.
  • Portal sends the email addresses to your webhook URL when users log in.

Other users can still choose to send Try It Out requests through the proxy or from the browser. By default, Swagger UI sends requests from the browser, and Elements sends them through the proxy. For more information see Routing API Requests for “Try It Out”.

Was this page helpful?