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

type

Defines the kind of user:

• USER: User of your organization
• SUB_ORG: Sub-organization that is part of your organization

permissions

Defines whether the user is allowed to create, read, update and delete entities

pipeline

Define whether the user can create, read, update and remove pipelines

create

Sets if the user can create new pipelines

read

Sets if the user can view single and all pipelines

write

Sets if the user can update pipelines

delete

Sets if the user can delete pipelines

execution

Defines whether the user can create, read, and fix executions

create

Sets if the user can create new executions

read

Sets if the user can view single and all executions

write

Sets if the user can fix executions

connector

Defines whether the user can create, read, update and remove connectors

create

Sets if the user can create new connectors

read

Sets if the user can view single and all connectors

write

Sets if the user can update connectors

delete

Sets if the user can delete connectors

tdm

Defines whether the user can create, read, update and remove target data models

create

Sets if the user can create new target data models

read

Sets if the user can view single and all target data models

write

Sets if the user can update target data models

delete

Sets if the user can delete target data models

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "type": "string",
    "permissions": {
      "pipeline": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "execution": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "connector": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      },
      "tdm": {
        "create": true,
        "read": true,
        "write": true,
        "delete": true
      }
    },
  }
}