Viewpoint Users REST APIs | Supported Operations | Teradata Viewpoint - 17.10 - Supported Operations - Teradata Data Lab - Teradata Viewpoint

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide

Product
Teradata Data Lab
Teradata Viewpoint
Release Number
17.10
Release Date
October 2021
Content Type
Programming Reference
Publication ID
B035-2215-101K
Language
English (United States)
HTTP URL Parameters Description Response
GET /api/public/users Optional Parameters
  • username: String used to limit results to users that starts with provided username case insensitivity.
  • role: String used to limit results to users with roles that starts with provided role case insensitivity.
  • perPage: Number of users to return per page. Default is 100. The upper limit is 500.
  • page: The page number to return. Default is 1.
Provide a list of all users A list of users
POST /api/public/users
Required Parameters
  • username
  • firstName
  • lastName
  • email
Optional Parameters
  • externallyAuthenticated
  • password
  • timeZone
  • locale
  • roles
Add a new User to Viewpoint. The new user can be either externally authenticated or local.
If the viewpoint user submitting the request has the role: VP_User_Manager, only own role or roles created by it can be added to the new user.

When successful, the response will be OK.

When unsuccessful, the response will be 400 for bad requests and 401 for unauthorized requests.

GET /api/public/users/{username} username in url Get a user from Viewpoint

When successful, the response will be OK.

When unsuccessful, the response will be 400 for bad requests, 401 for unauthorized requests, or 404 NOT Found if there is no such user.

PUT /api/public/users/{username}
Path Variable
  • username
Required Parameters
  • firstName
  • lastName
  • email
Optional Parameters
  • externallyAuthenticated
  • password
  • timeZone
  • locale
  • roles
Update the specified user. The full state of the user must be provided in the request, with the following exceptions:
  • If the password is omitted or set to null, the user's password will not be updated
  • If the list of roles is omitted or set to null, the user's roles will not be updated
The username should not be included in the request.
If the viewpoint user submitting the request has the role: VP_User_Manager, only own role or roles created by it can be added to the existing user. Existing roles which are not owned by VP_User_Manager remains unchanged.

When successful, the response will be OK.

When unsuccessful, the response will be 400 for bad requests and 401 for unauthorized requests.

PUT /api/public/users/{username}?changePassword
Path Variable
  • username
Required Parameter
  • password
Password change
  • Case 1: User can change their own password. username as path parameter, new password is required. (Authorization Header should be the username:password of the user requesting the API)
  • Case 2: User with Administrator role can change another User's password. username is required, new password is required.

When successful, the response will be OK.

When unsuccessful, the response will be 400 for bad requests and 401 for unauthorized requests.

DELETE /api/public/users/{username} Path Variable
  • username
Delete an existing user from Viewpoint When successful, the response will be OK