An admin account provides access to the Infoblox appliance. An admin account inherits the privileges and properties of the group to which it belongs.
References to adminuser are object references. The name part of a dmin User properties object reference has the following components:
Example: adminuser/ZG5zLm5ldHdvcmtfdmlldyQxMTk:user1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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 |
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
Notes
The admin_groups is part of the base object.
Determines the way of authentication
Type
String.
Create
The default value is KEYPAIR.
Search
The field is not available for search.
The authentication type for the admin user.
Type
String.
Create
The default value is LOCAL.
Search
The field is not available for search.
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
The serial number of the client certificate.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
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
Notes
The comment is part of the base object.
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.
The e-mail address for the admin user.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
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.
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.
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
Notes
The name is part of the base object.
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.
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 of the user account.
Type
String.
Search
The field is available for search via
Notes
The status cannot be updated.
status cannot be written.
The time zone for this admin user.
Type
String.
Create
The default value is (UTC) Coordinated Universal Time.
Search
The field is not available for search.
Notes
time_zone is associated with the field use_time_zone (see use flag).
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.
| 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 |
| 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.
| Field | Type | Search |
|---|---|---|
| role | String | = |
