adminuser : Admin User object.

An admin account provides access to the Infoblox appliance. An admin account inherits the privileges and properties of the group to which it belongs.

Object Reference

References to adminuser are object references. The name part of a dmin User properties object reference has the following components:

• The name of the admin user

Example: adminuser/ZG5zLm5ldHdvcmtfdmlldyQxMTk:user1

Restrictions

The object does not support the following operations:

• 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): admin_groups, comment, name.

The following fields are required to create this object:

Field	Notes
admin_groups
name
password	See the field description for more information

admin_groups

admin_groups

The names of the Admin Groups to which this Admin User belongs. Currently, this is limited to only one Admin Group.

Type

String array. The array supports a maximum of 1 element(s).

Create

The field is required on creation.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The admin_groups is part of the base object.

auth_method

auth_method

Determines the way of authentication

Type

String.

Valid values are:

• KEYPAIR

• KEYPAIR_PASSWORD

Create

The default value is KEYPAIR.

Search

The field is not available for search.

auth_type

auth_type

The authentication type for the admin user.

Type

String.

Valid values are:

• LOCAL

• REMOTE

• SAML

• SAML_LOCAL

Create

The default value is LOCAL.

Search

The field is not available for search.

ca_certificate_issuer

ca_certificate_issuer

The CA certificate that is used for user lookup during authentication.

Type

String.

This field supports nested return fields as described here.

Create

The default value is empty.

Search

The field is available for search via

• ‘=’ (exact equality)

client_certificate_serial_number

client_certificate_serial_number

The serial number of the client certificate.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

• ‘~=’ (regular expression)

• ‘=’ (exact equality)

comment

comment

Comment for the admin user; maximum 256 characters.

Type

String.

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

Create

The default value is empty.

Search

The field is available for search via

• ‘~=’ (regular expression)

• ‘=’ (exact equality)

• ‘:=’ (case insensitive search)

Notes

The comment is part of the base object.

disable

disable

Determines whether the admin user is disabled or not. When this is set to False, the admin user is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

email

email

The e-mail address for the admin user.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

enable_certificate_authentication

enable_certificate_authentication

Determines whether the user is allowed to log in only with the certificate. Regular username/password authentication will be disabled for this user.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

name

name

The name of the admin user.

Type

String.

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

Create

The field is required on creation.

Search

The field is available for search via

• ‘~=’ (regular expression)

• ‘=’ (exact equality)

• ‘:=’ (case insensitive search)

Notes

The name is part of the base object.

password

password

The password for the administrator to use when logging in.

Type

String.

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

Create

The password field is required if auth_type is not REMOTE or SAML.

Search

The field is not available for search.

Notes

password is not readable.

ssh_keys

ssh_keys

List of ssh keys for a particular user.

Type

A/An ‘List of ssh keys for a particular user struct array.

Create

The default value is:

empty

Search

The field is not available for search.

status

status

Status of the user account.

Type

String.

Valid values are:

• ACTIVE

• DISABLED

• INACTIVE

• LOCKED

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The status cannot be updated.

status cannot be written.

time_zone

time_zone

The time zone for this admin user.

Type

String.

Create

The default value is UTC.

Search

The field is not available for search.

Notes

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

use_ssh_keys

use_ssh_keys

,

Enable/disable the ssh keypair authentication.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

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.

Search-only Fields

These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.

role

role

The Role name to search for. If an empty string is specified, all users without Roles will be searched.

Type

String.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

role is a search-only field.

Fields List

Field	Type	Req	R/O	Base	Search
admin_groups	[String]	Y	N	Y	=
auth_method	String	N	N	N	N/A
auth_type	String	N	N	N	N/A
ca_certificate_issuer	String	N	N	N	=
client_certificate_serial_number	String	N	N	N	= ~
comment	String	N	N	Y	: = ~
disable	Bool	N	N	N	N/A
email	String	N	N	N	N/A
enable_certificate_authentication	Bool	N	N	N	N/A
extattrs	Extattr	N	N	N	ext
name	String	Y	N	Y	: = ~
password	String	Y*	N	N	N/A
ssh_keys	[struct]	N	N	N	N/A
status	String	N	Y	N	=
time_zone	String	N	N	N	N/A
use_ssh_keys	Bool	N	N	N	N/A
use_time_zone	Bool	N	N	N	N/A

* Required in some cases, see detailed field description above.

Search-only Fields List

Field	Type	Search
role	String	=