Skip to main content

Authentication API

The nuvo pipeline API uses a license key to authenticate requests.

Your license key carries many privileges, so be sure to keep it secure! Do not share your secret license key in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests should be made over HTTPS. API requests without authentication will fail.

Is it your first time using the nuvo pipeline API?​

  1. Follow our “Start with the nuvo pipeline API” guide for more detailed instructions
  2. Create users and sub-organizations via the nuvo API to generate, retrieve, and use their access tokens

Generate an access token​

Generate and retrieve an access token using your license key and your user e-mail or your sub-org’s identifier.

For a user​

cURL
Javascript
curl -X 'POST' 'https://api-gateway.getnuvo.com/dp/api/v1/auth/access-token' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "license_key": LICENSE KEY, "auth": { "identifier": E-MAIL, "type": "USER" } }' # Replace LICENSE_KEY with your license key & E-MAIL with a user's email

Response

{ "access_token": ACCESS_TOKEN }

For a sub-organization​

cURL
Javascript
curl -X 'POST' 'https://api-gateway.getnuvo.com/dp/api/v1/auth/access-token' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "license_key": LICENSE KEY, "auth": { "identifier": SUB_ORG_IDENTIFIER, "type": "SUB_ORG" } }' # Replace LICENSE_KEY with your license key & SUB_ORG_IDENTIFIER with a sub-org identifier

Response

{ "access_token": ACCESS_TOKEN }

Delete an access token​

If you want to invalidate an access token, you can do so with the following request:

cURL
Javascript
curl -X 'DELETE' 'https://api-gateway.getnuvo.com/dp/api/v1/auth/access-token' -H 'accept: application/json' -H 'access_token: 'ACCESS_TOKEN' # Replace ACCESS_TOKEN with an valid access token

Response

{ "message": "success" }

Verify an access token​

To ensure the access token you’re using is still valid, you can make the following request:

cURL
Javascript
curl -X 'POST' 'https://api-gateway.getnuvo.com/dp/api/v1/auth/verify' -H 'accept: application/json' -H 'access_token: ACCESS_TOKEN' # Replace ACCESS_TOKEN with an valid access token

Attributes

id

The ID of the user or sub-organisation to which the access token belongs

name

The name of the user or sub-organisation to which the access token belongs

Response

{ "data": { "id": string, "name": string } }