userprofile : User profile object.

The user profile of the admin who has logged in.

Object Reference

References to userprofile are object references.

The name part of the userprofile object reference has the following components:

  • The name of the user who has logged in.
Example:
userprofile/Li51c2VyX3Byb2ZpbGUkMjI:admin

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): name.

active_dashboard_type

active_dashboard_type

Determines the active dashboard type.

Type

String.

Valid values are:
  • INFO
  • TASK

Create

The default value is undefined.

Search

The field is not available for search.

admin_group

admin_group

The Admin Group object to which the admin belongs. An admin user can belong to only one admin group at a time.

Type

String.

Search

The field is not available for search.

Notes

The admin_group cannot be updated.

admin_group cannot be written.

days_to_expire

days_to_expire

The number of days left before the admin’s password expires.

Type

Integer.

Search

The field is not available for search.

Notes

The days_to_expire cannot be updated.

days_to_expire cannot be written.

email

email

The email address of the admin.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

global_search_on_ea

global_search_on_ea

Determines if extensible attribute values will be returned by global search or not.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

global_search_on_ni_data

global_search_on_ni_data

Determines if global search will search for network insight devices and interfaces or not.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

grid_admin_groups

grid_admin_groups

List of Admin Group objects that the current user is mapped to.

Type

String array.

Search

The field is not available for search.

Notes

The grid_admin_groups cannot be updated.

grid_admin_groups cannot be written.

last_login

last_login

The timestamp when the admin last logged in.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_login cannot be updated.

last_login cannot be written.

lb_tree_nodes_at_gen_level

lb_tree_nodes_at_gen_level

Determines how many nodes are displayed at generation levels.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

lb_tree_nodes_at_last_level

lb_tree_nodes_at_last_level

Determines how many nodes are displayed at the last level.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

max_count_widgets

max_count_widgets

The maximum count of widgets that can be added to one dashboard.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

name

name

The admin name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

old_password

old_password

The current password that will be replaced by a new password. To change a password in the database, you must provide both the current and new password values. This is a write-only attribute.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

old_password is not readable.

password

password

The new password of the admin. To change a password in the database, you must provide both the current and new password values. This is a write-only attribute.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

password is not readable.

table_size

table_size

The number of lines of data a table or a single list view can contain.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

time_zone

time_zone

The time zone of the admin user.

Type

String.

Valid values are:
  • (UTC + 10:00) Brisbane
  • (UTC + 10:00) Canberra, Sydney
  • (UTC + 10:00) Guam
  • (UTC + 10:00) Hobart
  • (UTC + 10:00) Melbourne, Victoria
  • (UTC + 10:00) Vladivostok
  • (UTC + 11:00) Magadan
  • (UTC + 11:00) Solomon Islands
  • (UTC + 12:00) Anadyr
  • (UTC + 12:00) Auckland
  • (UTC + 12:00) Fiji
  • (UTC + 12:00) Marshall Islands
  • (UTC + 1:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
  • (UTC + 1:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
  • (UTC + 1:00) Brussels, Copenhagen, Madrid, Paris
  • (UTC + 1:00) Casablanca
  • (UTC + 1:00) Sarajevo, Skopje, Sofija, Warsaw, Zagreb
  • (UTC + 2:00) Athens, Vilnius
  • (UTC + 2:00) Bucharest
  • (UTC + 2:00) Cairo
  • (UTC + 2:00) Harare
  • (UTC + 2:00) Helsinki
  • (UTC + 2:00) Jerusalem
  • (UTC + 2:00) Kaliningrad
  • (UTC + 3:00) Baghdad, Istanbul, Kuwait, Minsk, Riyadh
  • (UTC + 3:00) Moscow, St. Petersburg, Volgograd
  • (UTC + 3:00) Nairobi
  • (UTC + 3:30) Tehran
  • (UTC + 4:00) Baku
  • (UTC + 4:00) Dubai
  • (UTC + 4:00) Samara
  • (UTC + 4:30) Kabul
  • (UTC + 5:00) Ekaterinburg
  • (UTC + 5:00) Islamabad, Karachi
  • (UTC + 5:30) Bombay, Calcutta, Madras, New Delhi
  • (UTC + 5:30) Colombo
  • (UTC + 6:00) Dhaka
  • (UTC + 6:00) Omsk
  • (UTC + 6:30) Rangoon
  • (UTC + 7:00) Bangkok, Hanoi
  • (UTC + 7:00) Krasnoyarsk
  • (UTC + 8:00) Beijing, Chongqing, Shanghai
  • (UTC + 8:00) Hong Kong
  • (UTC + 8:00) Irkutsk
  • (UTC + 8:00) Perth
  • (UTC + 8:00) Singapore
  • (UTC + 8:00) Taipei
  • (UTC + 9:00) Osaka, Sapporo, Tokyo
  • (UTC + 9:00) Seoul
  • (UTC + 9:00) Yakutsk
  • (UTC + 9:30) Adelaide
  • (UTC + 9:30) Darwin
  • (UTC - 10:00) Hawaii
  • (UTC - 11:00) Midway Island, Samoa
  • (UTC - 12:00)
  • (UTC - 1:00) Azores
  • (UTC - 2:00) Mid-Atlantic
  • (UTC - 3:00) Brasilia
  • (UTC - 3:00) Buenos Aires
  • (UTC - 3:30) Newfoundland
  • (UTC - 4:00) Atlantic Time (Canada)
  • (UTC - 4:00) Caracas
  • (UTC - 4:00) Santiago
  • (UTC - 5:00) Bogota, Lima, Quito
  • (UTC - 5:00) Eastern Time (US and Canada)
  • (UTC - 5:00) Indiana (East)
  • (UTC - 6:00) Central Time (US and Canada)
  • (UTC - 6:00) Mexico City, Tegucigalpa
  • (UTC - 6:00) Saskatchewan
  • (UTC - 7:00) Arizona
  • (UTC - 7:00) Mountain Time (US and Canada)
  • (UTC - 8:00) Pacific Time (US and Canada), Tijuana
  • (UTC - 9:00) Alaska
  • (UTC) Coordinated Universal Time
  • (UTC) Dublin
  • (UTC) Lisbon
  • (UTC) London

Create

The default value is Empty value.

Search

The field is not available for search.

Notes

time_zone is associated with the field use_time_zone (see use flag).

use_time_zone

use_time_zone

Use flag for: time_zone

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

user_type

user_type

The admin type.

Type

String.

Valid values are:
  • LOCAL
  • REMOTE

Search

The field is not available for search.

Notes

The user_type cannot be updated.

user_type cannot be written.

Fields List

Field Type Req R/O Base Search
active_dashboard_type String N N N N/A
admin_group String N Y N N/A
days_to_expire Integer N Y N N/A
email String N N N N/A
global_search_on_ea Bool N N N N/A
global_search_on_ni_data Bool N N N N/A
grid_admin_groups [String] N Y N N/A
last_login Timestamp N Y N N/A
lb_tree_nodes_at_gen_level Unsigned int N N N N/A
lb_tree_nodes_at_last_level Unsigned int N N N N/A
max_count_widgets Unsigned int N N N N/A
name String N Y Y N/A
old_password String N N N N/A
password String N N N N/A
table_size Unsigned int N N N N/A
time_zone String N N N N/A
use_time_zone Bool N N N N/A
user_type String N Y N N/A