Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Swagger UI is loaded but cannot test endpoints yet
  • Need to authenticate first

...


Step 2: Click "Authorize" Button

What happens:

  • Developer clicks the "Authorize" button (or clicks a lock icon)
  • Modal dialog appears showing available security schemes
  • Shows OAuth2 (Authorization Code with PKCE) security scheme
  • Displays the required scope for the API

Who's involved:

  • Developer
  • Swagger UI

Authorization modal shows:

For ApiService:

oauth2 (OAuth2, authorizationCode with PKCE)
Scopes:
  api://4dad5d62-dc8c-4378-8bd0-ae736a4d73fe/access_as_user - Access API as user

For IntegrationServiceAPI:

oauth2 (OAuth2, authorizationCode with PKCE)
Scopes:
  api://bd5100ee-af63-4880-8c60-47d4207d60c1/access_as_user - Access Integration API as user

Result:

  • Developer sees what permissions will be requested
  • Ready to start OAuth2 flow

...


Step 3: Initiate OAuth2 Flow

What happens:

  • Developer clicks "Authorize" in the modal
  • Swagger UI starts the OAuth2 Authorization Code flow
  • Browser redirects to Microsoft Entra ID login page
  • Security code (PKCE) generated automatically

Who's involved:

  • Swagger UI
  • Microsoft Entra ID

What's sent to Microsoft:

  • Swagger client ID
  • Which API scope is needed
  • Security challenge code (PKCE)
  • Where to redirect back after login

Result:

  • Browser redirected to Microsoft login page

...


Step 4: Developer Enters Credentials

...