Single Sign-On (SSO)

Single sign-on is used with the hosted pages to directly log in customers to the self-service portal. This allows a business to skip setting up customer credentials in Stax Bill, so customers can skip the login page to the self service portal.

This guide provides steps and tips for using single sign-on authentication to the Stax Bill Self-Service Portal from another application.

There is additional information on setting up Single Sign-On (SSO) in the support documentation.

🚧

Test before deploying.

While single sign-on is enabled, customers will not be able to log into the portal using credentials set up in Stax Bill for the self-service portal.

It is strongly recommended that this is tested in a sandbox account before to turning this on in a live account.

Generate a token for the customer

A token is generated by calling the Read Token endpoint.

📘

Notes About Tokens

1. Each token that is generated is valid for a single customer that is specified in the URL.
2. Generating a token for a customer will invalidate all previous tokens for that customer.
3. The token can only be used once. It will be consumed upon that first use.
4. The token expires very quickly, so the customer should be directed to their portal as soon as the token is received.

A sample request/response is shown below:

GET /v1/SingleSignOn/GetSingleSignOnToken/339686 HTTP/1.1
Host: secure.fusebill.com
Authorization: Basic {{YourAPIKey}}
Cache-Control: no-cache

"222b1998-4afb-4844-a3b2-e9b488dbb4e8"

Direct the Customer to the Portal

The subdomain of the self-service portal is set up in the Stax Bill Admin UI in the "Key" field on the portals page, in the "Domain" section.

The homepage of the Self-Service portal will be:

https://{yourpagekey}.mybillsystem.com/ManagedPortal/Home

To log the customer into the Self-Service Portal using the generated token, the token is appended to above URL. Example:

https://{yourpagekey}.mybillsystem.com/ManagedPortal/Home?token=222b1998-4afb-4844-a3b2-e9b488dbb4e8

The above URL will automatically log the customer into the portal under the Fusebill ID specified in the request, and consume the token.

This can also be used to direct existing customers to an offerings page:

https://{yourpagekey}.mybillsystem.com/Offerings/{yourofferingspagekey}

📘

Directing to other areas of the portal

You can direct the customer to a sub-page within the portal. These are the following pages:
Home: https://yourpagename.mybillsystem.com/ManagedPortal/Home?token=
Invoices: https://yourpagename.mybillsystem.com/ManagedPortal/Invoices?token=
Statements: https://yourpagename.mybillsystem.com/ManagedPortal/Statements?token=
Payment Methods: https://yourpagename.mybillsystem.com/ManagedPortal/PaymentMethod?token=
Profile: https://yourpagename.mybillsystem.com/ManagedPortal/Profile?token=
Subscriptions: https://yourpagename.mybillsystem.com/ManagedPortal/Subscriptions?token=
Offerings Page: https://yourpagename.mybillsystem.com/Offerings/youroffieringpagename?token=

📘

Error 400: "Single Sign-on not enabled."

This error will be returned from read token when single sign-on has not been enabled for this hosted page. A user will need to log into the admin panel, navigate to the portal, and then enable single sign-on. Remember that while this is on, users will not be able to log into the Self-Service using the credentials and login page if they were set up with Stax Bill.