BarTender Cloud offers password-based OAuth 2.0 with Open ID Connect (OIDC) for Console Applications and Services to gain access to the BarTender Cloud Rest API. OAuth is an authentication mechanism which allows services to share data with third party web apps.
While OAuth usually serves as an alternative to sharing login credentials and the security risks this entails (See here for more info), it can also be used in conjunction with username and password credentials. OIDC is an open authentication protocol that works on top of the OAuth 2.0 framework.
This article offers a detailed look at how OAuth works with usernames and passwords. As this is an advanced topic, this article is geared towards those individual who are already familiar with or have advanced knowledge of this subject.
BarTender Cloud REST API
In order to use your credentials for Password-Based authentication, you will need to enable this for the corresponding BarTender Cloud account. Do this by following the steps below:
- Click on the hamburger menu and navigate to Manage Cloud Account > Users.
- Expand the user options by selecting the verticle ellipsis icon to the right of the user in question.
- Click Edit.
- Click the box next to Allow password-based API access to enable this feature.
- Click Save at the bottom.
Registering Your Application for Password-Based Access
Once you've enabled password-based API access for your User profile, it's time to register your application with BarTender Cloud.
- From the hamburger menu in the upper-left corner of BarTender Cloud and select Manage Cloud Account.
- Select BarTender Cloud API in the left-hand toolbar.
- Click Register Application for Password-Based Access under Console Applications and Services (Password-Based).
- Complete the following fields and click Register:
Name: Specifies a name for the application or service. This is the "friendly" display name.
Description: Specifies an optional description for the application or service.
- Your newly registered application or service will be listed on the BarTender Cloud API property page.
Completing registration will generate an Application ID and Application Secret. Click the verticle ellipsis icon to the right of your registered application and select View ID & Secret to view them.
This will be used alongside your BarTender Cloud username and password to generate your access token to make BarTender Cloud REST API calls. If you need to change the ID and Secret, you can do this by selecting the Rotate ID & Secret button as seen in the above Web Registration ID and Secret dialog.
OAuth Technical Details
BarTender Cloud uses the OAuth provider Auth0 to handle the authentication process and third-party applications must use their API in order to authenticate with BarTender Cloud.
OAuth Resource Owner Password Flow
Below is a step-by-step explanation of the Resource Owner Password flow when you try to authenticate with BarTender Cloud through a third-party console application or service(the Client) to access your tenant space:
Select Login within the application and enter your credentials.
Auth0's SDK forwards your credentials and the Application ID & Secret to the authorization server. The URLs for this are:
- BarTender Cloud Americas and APJ environments: https://bartendercloud-production.us.auth0.com/oauth/token
- BarTender Cloud EMEA environment: https://bartendercloud-production.eu.auth0.com/oauth/token
- Application/Client ID used to identify your application - Generated when the application was registered in BarTender Cloud
- Application/Client secret used to prove ownership of the ClientID - Generated when the application was registered in BarTender Cloud
Your Auth0 Authorization Server validates the credentials, Application ID & Secret.
Your Auth0 Authorization Server responds with an Access Token (and, optionally, a Refresh Token).
The application can use the Access Token to call the API to access BarTender Cloud data and functions.
The API responds with the requested data.
- BarTender Cloud REST API Authentications and Tokens
- BarTender Cloud REST API Application Types
- BarTender Cloud REST API Authenticating Using OAuth
Additional External Resources (all rights reserved):