List of all users
{
"content":[
{
"first_name":"John"
"last_name":"Smith",
"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",
"user_creation_timestamp": "2022-09-01T08:39:40.011Z",
"user_modification_timestamp": "2022-09-01T08:42:03.716Z",
"user_modified_by": "admin",
"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/v2/public/users?per_page=100&page=2"
},
{
"rel":"first",
"href":"http://ViewpointHost/api/v2/public/users?per_page=100&page=1"
},
{
"rel":"last",
"href":"http://ViewpointHost/api/v2/public/users?per_page=100&page=20"
},
{
"rel":"self",
"href":"http://ViewpointHost/api/v2/public/users?per_page=100&page=1"
}
]
}
Add new user
{
"user_name":"js251068", //The username or login for the user. This name is used to uniquely identify the user.
"externally_authenticated":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
"first_name":"John", //The first name of the user. required
"last_name":"Smith", //The last name of the user. required
"email":"jsmith@teradata.com", //The email address of the user. required
"password":"secret", //The password of the new user is required if externallyAuthenticated is false.
"time_zone":"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
}