OAuth authentication

Portainer Business Edition can be connected to several OAuth providers in an easy way without need to understand complex configurations.

To configure OAuth as the external authentication source for Portainer, go to Settings > Authentication and select OAuth.

oauth

In this screen, you have the following options:

  • Use SSO: Using SSO, the OAuth provider is not forced to prompt for credentials when the user has a currently logged in session.
  • Hide internal authentication prompt: With this toggle on, Portainer will bypass the Portainer Login screen and use SSO to login a user with an existing OAuth session or takes the user straight to OAuth provider login.

            Note: Use <portainer url>/#!/internal-auth to login as Portainer internal admin

  • Automatic User Provisioning: Toggle on the Automatic User Provisioning to see the options. You can use this option if you want a user added to Portainer for each OAuth user on first login. After enabling the toggle, you may choose a team for these Auto Populated Users.
  • Automatic Team membership: You may choose to auto add OAuth users to certain Portainer teams based on the Claim Name. Claim names with be matched with Teams or you can manually link a claim name (regex) with Portainer Teams.

Provider

You may choose any of the following providers or use Custom Provider.

Click on the name for provider specific instructions

Manage access to OAuth Team and Users

To understand how to enable access to OAuth Teams and Users, please, refer to this article.

Notes

Contribute to these docs