Skip to main content

User API

Users represent members of your organization. With the user API, you can manage who can create, view, edit/update, and delete pipelines, executions, connectors, and target data models.

Use this base URL and add the corresponding endpoint respectively:

Base URL

api-gateway.getnuvo.com/dp/api/v1/

Create​

Endpoint

POST /user/

Payload​

Attributes

email

The email address of the user you want to add

identifier

The identifier to uniquely recognize users. If no identifier is set it will be the email address

first_name

The first name of the user you want to add

last_name

The last name of the user you want to add

role

The role of the user which gives them rights within the organization

  • MEMBER: Can invite other users
  • OWNER: Can also make users to owners as well as delete users from the organization

position

The role the user has within your organization. If none of these roles fit choose the one closest to the role:

  • C-Level
  • Customer Success
  • Product Manager
  • Developer

password

The password for the user account you're creating

permissions

Defines per pipeline component whether the user is allowed to create, read, update and delete them using true values

pipeline

Defines 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

Payload

{
  "email": "string",
  "identifier": "string",
  "first_name": "string",
  "last_name": "string",
  "role": "OWNER",
  "password": "string",
  "position": "C-Level",
  "permissions": {
    "pipeline": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "execution": {
      "create": true,
      "read": true,
      "write": true
    },
    "connector": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "tdm": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    }
  }
}

Response​

Attributes

id

The ID of the user

email

The email address of the user you want to add

identifier

The identifier to uniquely recognize users. If no identifier is set it will be the email address

first_name

The first name of the user you want to add

last_name

The last name of the user you want to add

role

The role of the user which gives them rights within the organization

  • MEMBER: Can invite other users
  • OWNER: Can also make users to owners as well as delete users from the organization

position

The role the user has within your organization. If none of these roles fit choose the one closest to the role:

  • C-Level
  • Customer Success
  • Product Manager
  • Developer

permissions

Defines per pipeline component whether the user is allowed to create, read, update and delete them using true values

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

oauth_provider

The OAuth provider used for the new user account. When creating users via the API this field is always "EMAIL".

verified

Indicates whether user has verified their email address

last_update_password

The date and time when the password of this user was last updated. E.g. 2022-03-07 12:48:28.653

joined_date

The date and time when the user verified their email address. E.g. 2022-03-07 12:48:28.653

created_at

The date and time when the user was first created

created_by

Information of whom created the user

id

The ID of the user or sub-organization who created the user

name

The name of the user or sub-organization who created the user

identifier

The identifier of the user or sub-organization who created the user

type

Defines the kind of user who created the user:

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

updated_at

The date and time when the user was last updated

updated_by

Information of whom last updated the user

id

The ID of the user or sub-organization who last updated the user

name

The name of the user or sub-organization who last updated the user

identifier

The identifier of the user or sub-organization who last updated the user

type

Defines the kind of user who last updated the user:

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

Response

{
  "data": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "identifier": "string",
    "email": "string",
    "role": "OWNER",
    "position": "C-Level",
    "verified": true,
    "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
      }
    },
    "oauth_provider": "EMAIL",
    "last_update_password": "2022-03-07 12:48:28.653",
    "joined_date": "2022-03-07 12:48:28.653",
    "created_at": "2022-03-07 12:48:28.653",
      "created_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      },
    "updated_at": "2022-03-07 12:48:28.653",
    "updated_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      }
  }
}

Update​

Endpoint

PUT /user/{id}

Payload​

Attributes

email

The email address of the user you want to add

identifier

The identifier to uniquely recognize users. If no identifier is set it will be the email address

first_name

The first name of the user you want to add

last_name

The last name of the user you want to add

role

The role of the user which gives them rights within the organization

  • MEMBER: Can invite other users
  • OWNER: Can also make users to owners as well as delete users from the organization

password

The password for the user account you're creating

permissions

Defines per pipeline component whether the user is allowed to create, read, update and delete them using true values

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

Payload

{
  "identifier": "string",
  "first_name": "string",
  "last_name": "string",
  "role": "OWNER",
  "position": "string",
  "permissions": {
    "pipeline": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "execution": {
      "create": true,
      "read": true,
      "write": true
    },
    "connector": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    },
    "tdm": {
      "create": true,
      "read": true,
      "write": true,
      "delete": true
    }
  }
}

Response​

Attributes

id

The ID of the user

email

The email address of the user you want to add

identifier

The identifier to uniquely recognize users. If no identifier is set it will be the email address

first_name

The first name of the user you want to add

last_name

The last name of the user you want to add

role

The role of the user which gives them rights within the organization

  • MEMBER: Can invite other users
  • OWNER: Can also make users to owners as well as delete users from the organization

position

The role the user has withing your organization. If none of these roles fit choose the one closest to the role:

  • C-Level
  • Customer Success
  • Product Manager
  • Developer

permissions

Defines per pipeline component whether the user is allowed to create, read, update and delete them using true values

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

oauth_provider

The OAuth provider used for the user account:

  • GITHUB
  • GOOGLE
  • EMAIL

verified

Indicates whether user has verified their email address

last_update_password

The date and time when the password of this user was last updated. E.g. 2022-03-07 12:48:28.653

joined_date

The date and time when the user verified their email address. E.g. 2022-03-07 12:48:28.653

created_at

The date and time when the user was first created

created_by

Information of whom created the user

id

The ID of the user or sub-organization who created the user

name

The name of the user or sub-organization who created the user

identifier

The identifier of the user or sub-organization who created the user

type

Defines the kind of user who created the user:

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

updated_at

The date and time when the user was last updated

updated_by

Information of whom last updated the user

id

The ID of the user or sub-organization who last updated the user

name

The name of the user or sub-organization who last updated the user

identifier

The identifier of the user or sub-organization who last updated the user

type

Defines the kind of user who last updated the user:

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

Response

{
  "data": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "identifier": "string",
    "email": "string",
    "role": "OWNER",
    "position": "C-Level",
    "verified": true,
    "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
      }
    },
    "oauth_provider": "EMAIL",
    "last_update_password": "2022-03-07 12:48:28.653",
    "joined_date": "2022-03-07 12:48:28.653",
    "created_at": "2022-03-07 12:48:28.653",
      "created_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      },
    "updated_at": "2022-03-07 12:48:28.653",
    "updated_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      }
  }
}

Read by ID​

Endpoint

GET /user/{id}

Response​

Attributes

id

The ID of the user

email

The email address of the user you want to add

identifier

The identifier to uniquely recognize users. If no identifier is set it will be the email address

first_name

The first name of the user you want to add

last_name

The last name of the user you want to add

role

The role of the user which gives them rights within the organization

  • MEMBER: Can invite other users
  • OWNER: Can also make users to owners as well as delete users from the organization

position

The role the user has withing your organization. If none of these roles fit choose the one closest to the role:

  • C-Level
  • Customer Success
  • Product Manager
  • Developer

permissions

Defines per pipeline component whether the user is allowed to create, read, update and delete them using true values

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

oauth_provider

The OAuth provider used for the user account:

  • GITHUB
  • GOOGLE
  • EMAIL

verified

Indicates whether user has verified their email address

last_update_password

The date and time when the password of this user was last updated. E.g. 2022-03-07 12:48:28.653

joined_date

The date and time when the user verified their email address. E.g. 2022-03-07 12:48:28.653

created_at

The date and time when the user was first created

created_by

Information of whom created the user

id

The ID of the user or sub-organization who created the user

name

The name of the user or sub-organization who created the user

identifier

The identifier of the user or sub-organization who created the user

type

Defines the kind of user who created the user:

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

updated_at

The date and time when the user was last updated

updated_by

Information of whom last updated the user

id

The ID of the user or sub-organization who last updated the user

name

The name of the user or sub-organization who last updated the user

identifier

The identifier of the user or sub-organization who last updated the user

type

Defines the kind of user who last updated the user:

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

Response

{
  "data": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "identifier": "string",
    "email": "string",
    "role": "OWNER",
    "position": "C-Level",
    "verified": true,
    "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
      }
    },
    "oauth_provider": "EMAIL",
    "last_update_password": "2022-03-07 12:48:28.653",
    "joined_date": "2022-03-07 12:48:28.653",
    "created_at": "2022-03-07 12:48:28.653",
      "created_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      },
    "updated_at": "2022-03-07 12:48:28.653",
    "updated_by": {
        "id": "string",
        "name": "string",
        "identifier": "string",
        "type": "USER"
      }
  }
}

Read all​

To further refine the response you can use query parameters like sort, filters, pagination and options. Look at a more detailed explanation here.

Endpoint

GET /user/

Response​

Attributes

id

The ID of the user

email

The email address of the user you want to add

identifier

The identifier to uniquely recognize users. If no identifier is set it will be the email address

first_name

The first name of the user you want to add

last_name

The last name of the user you want to add

role

The role of the user which gives them rights within the organization

  • MEMBER: Can invite other users
  • OWNER: Can also make users to owners as well as delete users from the organization

position

The role the user has withing your organization. If none of these roles fit choose the one closest to the role:

  • C-Level
  • Customer Success
  • Product Manager
  • Developer

oauth_provider

The OAuth provider used for the user account:

  • GITHUB
  • GOOGLE
  • EMAIL

verified

Indicates whether user has verified their email address

last_update_password

The date and time when the password of this user was last updated. E.g. 2022-03-07 12:48:28.653

joined_date

The date and time when the user verified their email address. E.g. 2022-03-07 12:48:28.653

created_at

The date and time when the user was first created

created_by

Information of whom created the user

id

The ID of the user or sub-organization who created the user

name

The name of the user or sub-organization who created the user

identifier

The identifier of the user or sub-organization who created the user

type

Defines the kind of user who created the user:

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

updated_at

The date and time when the user was last updated

updated_by

Information of whom last updated the user

id

The ID of the user or sub-organization who last updated the user

name

The ame of the user or sub-organization who last updated the user

identifier

The identifier of the user or sub-organization who last updated the user

type

Defines the kind of user who last updated the user:

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

pagination

An object containing metadata about the result

total

The 0 of entries in the data array

offset

The offset set in the request parameters

limit

The limit set in the request parameters

Response

{
  "data": [
    {
      "id": "string",
      "first_name": "string",
      "last_name": "string",
      "identifier": "string",
      "email": "string",
      "role": "OWNER",
      "position": "C-Level",
      "verified": true,
      "oauth_provider": "EMAIL",
      "last_update_password": "2022-03-07 12:48:28.653",
      "joined_date": "2022-03-07 12:48:28.653",
      "created_at": "2022-03-07 12:48:28.653",
        "created_by": {
          "id": "string",
          "name": "string",
          "identifier": "string",
          "type": "USER"
        },
      "updated_at": "2022-03-07 12:48:28.653",
      "updated_by": {
          "id": "string",
          "name": "string",
          "identifier": "string",
          "type": "USER"
        }
    }
  ],
  "pagination": {
    "total": 0,
    "offset": 0,
    "limit": 0
  }
}

Delete​

Endpoint

DELETE /user/{id}

Response​

Attributes

message

Message confirming the deletion of the user or providing an error message

Response

{
  "data": {
    "message": "string"
  }
}