Skip to main content

Authorization

Follow this guide to create a new Cue credential that will allow Nexla to authenticate to and exchange data with your Cue account.
cue_api_auth.png

Cue

Prerequisites​

Before creating a Cue credential, you need to obtain your Cue API URL, User ID, Organization ID, Access Token, and Client ID from your Cue account. These values are required to authenticate with the Cue API using JWT/Token authentication.

To obtain your credentials, you need to have a Cue account with API access enabled. Once you have access to your account, you can generate an access token and obtain your User ID, Organization ID, and Client ID from your Cue account settings. Cue uses JWT/Token authentication with custom headers (X-Api-Consumer and X-Cue-UserId) and an Authorization header with a Bearer token. The access token is used to refresh the JWT token, which is then used to authenticate all API requests to the Cue API. For detailed information about API authentication and credential setup, refer to the Cue API documentation.

Create a Cue Credential​

  • To create a new Cue credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Cue

CueCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Cue API URL​

  1. Enter the root URL of your Cue instance API in the Cue API URL field. This should be the base URL for your Cue API instance (e.g., https://yourcuesite.com/api). The API URL is used to construct the full endpoint URLs for API requests.

    The Cue API URL should be the root URL of your Cue instance API, typically in the format https://yourcuesite.com/api where yourcuesite.com is your Cue instance domain. The API URL is used to construct the full endpoint URLs for API requests. For detailed information about determining your API URL, see the Cue API documentation.

User ID​

  1. Enter your unique Cue user ID in the User ID field. This is the unique identifier for your Cue user account. The User ID is sent in the X-Cue-UserId header for all API requests to the Cue API.

    The User ID is your unique Cue user identifier. The User ID is sent in the X-Cue-UserId header for all API requests to the Cue API. You can find your User ID in your Cue account settings.

Organization ID​

  1. Enter the identifier for your Cue organization in the Organization ID field. This is the unique identifier of your Cue organization.

    The Organization ID is the unique identifier for your Cue organization. You can find your Organization ID in your Cue account settings.

Access Token​

  1. Enter your individual access token generated in Cue in the Access Token field. This is the access token you obtained from your Cue account. The access token is used to refresh the JWT token, which is then used to authenticate all API requests to the Cue API.

    Keep your access token secure and do not share it publicly. The access token provides access to your Cue account and should be treated as sensitive information. The access token is used to refresh the JWT token from the token refresh endpoint ({api_url}/v1/users/refresh-token), which is then used to authenticate all API requests to the Cue API. For detailed information about generating and managing access tokens, see the Cue API documentation.

Client ID​

  1. Enter the ID for your Cue application in the Client ID field. This is the Client ID for your Cue application. The Client ID is sent in the X-Api-Consumer header for all API requests to the Cue API.

    The Client ID is the identifier for your Cue application. The Client ID is sent in the X-Api-Consumer header for all API requests to the Cue API. You can find your Client ID in your Cue account settings or application configuration.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.