Viewpoint Users REST APIs | Data Objects | Teradata Viewpoint - 17.10 - Data Objects - 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)

List of all users

{
   "content":[
      {
         "first_name":"Smith"
         "last_name":"John",
         "username":"jsmith",
         "email":"jsmith@teradata.com",
         "last_login":"2018-04-09T16:48:59Z",
         "roles":["Administrator","User"],
         "is_externally_authenticated":false,
         "time_zone": "America/Los_Angeles",
         "locale":"en_US"
      },
      ... more records ...
   ],
   "data": {
         "per_page":100,
         "page":1,
         "total_pages":3,
         "total_elements":260,
         "number_of_elements":100,
         "first_page":true,
         "last_page":false,
   },  
   "links":[
      {
         "rel":"next",
         "href":"http://ViewpointHost/api/public/users?perPage=100&page=2"
      },
      {
         "rel":"first",
         "href":"http://ViewpointHost/api/public/users?perPage=100&page=1"
      },
      {
         "rel":"last",
         "href":"http://ViewpointHost/api/public/users?perPage=100&page=20"
      },
      {
         "rel":"self",
         "href":"http://ViewpointHost/api/public/users?perPage=100&page=1"
      }
   ]
}

Add new user

{
    "username":"ab123456",                 //The username or login for the user. This name is used to uniquely identify the user.
    "externallyAuthenticated":false,       //If this attribute is set to false the user is authenticated against a password stored in Viewpoint
                                           //If the attribute is set to true the user will be authenticated against an external LDAP server. default value is false
    "firstName":"John",                    //The first name of the user. required
    "lastName":"Doe",                      //The last name of the user. required
    "email":"johndoe@teradata.com",        //The email address of the user. required
    "password":"secret",                   //The password of the new user is required if externallyAuthenticated is false.
    "timeZone":"America/Denver",           //Timezone for the user. The format of this field is time zone IDs specified by the java.util.TimeZone class.
    "locale":"en_US",                      //The locale for the user. The format of this field is 2 letter language code, an underscore and 2 letter country code from java.util.Locale
    "roles":["User", "Administrator"]      //An array of roles assigned to the user. The order of the roles is important. Roles listed first have higher precedence.
}
Change local user password
{
    "password": "testpwd"                   //new valid password. required
}