Octopus Deploy Documentation

Building a Forms based Authentication Provider

Last updated

All Forms based providers share the Username/Password/Remember Me UI shipping with the Octopus Deploy UI.  To participate as a Forms based authentication provider you must:

  • Host an API endpoint that:
    • expects a Http POST of a LoginCommand object.
    • returns a JSON representation of an IUser and a cookie, as returned by a call to IAuthCookieCreator.CreateAuthCookie.
  • Implement the IAuthenticationProvider interface and have:
    • GetAuthenticationProviderElement return an element with:
      • a Name.
      • FormsLoginEnabled = true.
      • Links containing path to the API from above.
    • GetAuthenticationUrls return the same API url (which is used to whitelisting APIs when in MaintenanceMode etc).
  • Implement whatever configuration storage you require.

The Octopus Deploy UsernamePasswordAuthenticaionProvider on GitHub provides a good reference point.

Welcome! We use cookies and data about how you use our website allow us to improve the website and your experience, and resolve technical errors. Our website uses cookies and shares some of your data with third party analytics companies for these purposes.

If you decline, we will respect your privacy. A single cookie will be used in your browser to remember your preference.