Difference between revisions of "WHMCS Single Sign-On Developer Guide"
From WHMCS Documentation
(Created page with "WHMCS Single Sign-on allows trusted applications and third parties to authenticate users into a WHMCS installation automatically, without the user having to re-authenticate....") |
(→Supported Destinations) |
||
| Line 17: | Line 17: | ||
<table class="table table-striped"> | <table class="table table-striped"> | ||
| − | <tr> | + | <tr><td>'''Scope Name'''</td><td>'''Destination'''</td></tr> |
| − | <td>'''Scope Name'''</td> | + | <tr><td>clientarea:profile</td><td>My Details</td></tr> |
| − | <td>'''Destination'''</td> | + | <tr><td>clientarea:billing_info</td><td>Manage Billing Information/Credit Card</td></tr> |
| − | </tr> | + | <tr><td>clientarea:emails</td><td>My Emails</td></tr> |
| − | <tr> | + | <tr><td>clientarea:announcements</td><td>Announcements</td></tr> |
| − | <td>clientarea: | + | <tr><td>clientarea:downloads</td><td>Downloads</td></tr> |
| − | <td>My Details</td> | + | <tr><td>clientarea:knowledgebase</td><td>Knowledgebase</td></tr> |
| − | </tr> | + | <tr><td>clientarea:network_status</td><td>Network Status</td></tr> |
| + | <tr><td>clientarea:services</td><td>My Products/Services</td></tr> | ||
| + | <tr><td>clientarea:product_details</td><td>Product Details/Information</td></tr> | ||
| + | <tr><td>clientarea:domains</td><td>My Domains</td></tr> | ||
| + | <tr><td>clientarea:domain_details</td><td>Domain Details/Information</td></tr> | ||
| + | <tr><td>clientarea:invoices</td><td>My Invoices</td></tr> | ||
| + | <tr><td>clientarea:tickets</td><td>My Support Tickets</td></tr> | ||
| + | <tr><td>clientarea:submit_ticket</td><td>Open New Ticket</td></tr> | ||
| + | <tr><td>clientarea:shopping_cart</td><td>Shopping Cart Default Product Group</td></tr> | ||
| + | <tr><td>clientarea:shopping_cart_addons</td><td>Shopping Cart Addons</td></tr> | ||
| + | <tr><td>clientarea:shopping_cart_domain_register</td><td>Shopping Cart Register Domain</td></tr> | ||
| + | <tr><td>clientarea:shopping_cart_domain_transfer</td><td>Shopping Cart Transfer Domain</td></tr> | ||
</table> | </table> | ||
Revision as of 00:16, 6 December 2015
WHMCS Single Sign-on allows trusted applications and third parties to authenticate users into a WHMCS installation automatically, without the user having to re-authenticate.
Our Single Sign-On implementation is based on the popular and widely used OAuth 2.0 authorization framework which outlines a secure workflow for accessing user data while protecting their account credentials.
Single Sign-on Workflow
Here's how the process works.
- The application requests an access token by sending its credentials to the OAuth Token API Endpoint
- If the application credentials check out, the WHMCS auth server will return an access token to the application
- The application then redirects the user to the Single Sign-On API Endpoint passing in the token and desired destination (scope)
- The user is authenticated and redirected to the requested destination.
Performing Single Sign-On requires an OAuth Credential Set with the single sign-on grant type.
Supported Destinations
| Scope Name | Destination |
| clientarea:profile | My Details |
| clientarea:billing_info | Manage Billing Information/Credit Card |
| clientarea:emails | My Emails |
| clientarea:announcements | Announcements |
| clientarea:downloads | Downloads |
| clientarea:knowledgebase | Knowledgebase |
| clientarea:network_status | Network Status |
| clientarea:services | My Products/Services |
| clientarea:product_details | Product Details/Information |
| clientarea:domains | My Domains |
| clientarea:domain_details | Domain Details/Information |
| clientarea:invoices | My Invoices |
| clientarea:tickets | My Support Tickets |
| clientarea:submit_ticket | Open New Ticket |
| clientarea:shopping_cart | Shopping Cart Default Product Group |
| clientarea:shopping_cart_addons | Shopping Cart Addons |
| clientarea:shopping_cart_domain_register | Shopping Cart Register Domain |
| clientarea:shopping_cart_domain_transfer | Shopping Cart Transfer Domain |