Get List of Users

To see all the users registered in the cloud with their detailed information, use the following request:

GET /users.xml
GET /users.json

XML Request Example

curl -i -X GET -u user:password --url http://onapp.test/users.xml

JSON Request Example

curl -i -X GET -u user:password --url http://onapp.test/users.json

XML Output Example

<users type="array">
<user>
<activated_at type="datetime">2012-04-03T14:30:34+00:00</activated_at>
<avatar nil="true"/>
<cdn_account_status>ACTIVE</cdn_account_status>
<cdn_status>ACTIVE</cdn_status>
<created_at type="datetime">2012-04-03T14:30:34+00:00</created_at>
<deleted_at nil="true"/>
<email>admin@example.com</email>
<firewall_id type="integer">4</firewall_id>
<first_name>John</first_name>
<group_id nil="true"/>
<id type="integer">1</id>
<identifier>cjximrxmt3yjbs</identifier>
<image_template_group_id nil="true"/>
<infoboxes>
<display_infoboxes type="boolean">false</display_infoboxes>
<hidden_infoboxes type="array">
<hidden_infobox>4840313084eef1f8e1dada293eb1b1ae</hidden_infobox>
</hidden_infoboxes>
</infoboxes>
<last_name>Smith</last_name>
<locale>en</locale>
<login>admin</login>
<password_changed_at type="datetime">2014-08-21T16:00:15+03:00</password_changed_at>
<registered_yubikey>true</registered_yubikey>
<status>active</status>
<supplied type="boolean">false</supplied>
<suspend_at nil="true"/>
<system_theme>dark</system_theme>
<time_zone>Baghdad</time_zone>
<updated_at type="datetime">2012-05-21T11:30:20+00:00</updated_at>
<use_gravatar type="boolean">false</use_gravatar>
<user_group_id nil="true"/>
<bucket_id type="integer">201</bucket_id>
<used_cpus type="integer">0</used_cpus>
<used_memory type="integer">0</used_memory>
<used_cpu_shares type="integer">0</used_cpu_shares>
<used_disk_size type="integer">0</used_disk_size>
<memory_available type="integer">3091</memory_available>
<disk_space_available type="integer">278</disk_space_available>
<roles type="array">
<role>
<created_at type="datetime">2012-04-03T14:30:31+00:00</created_at>
<id type="integer">1</id>
<identifier>admin</identifier>
<label>Administrator</label>
<updated_at type="datetime">2012-04-20T10:28:32+00:00</updated_at>
<permissions type="array">
<permission>
<created_at type="datetime">2012-04-03T14:30:31+00:00</created_at>
<id type="integer">110</id>
<identifier>autobackup_templates</identifier>
<updated_at type="datetime">2012-04-03T14:30:31+00:00</updated_at>
</permission>
</permissions>
</role>
</roles>
<monthly_price type="decimal">0.0</monthly_price>
<payment_amount type="decimal">1289749212.12321</payment_amount>
<outstanding_amount type="decimal">-1289749212.12321</outstanding_amount>
<total_amount type="decimal">0.0</total_amount>
<discount_due_to_free type="decimal">0.0</discount_due_to_free>
<total_amount_with_discount type="decimal">0.0</total_amount_with_discount>
<additional_fields type="array">
<additional_field>
<name>add_field1</name>
<value>0</value>
</additional_field>
</additional_fields>
<used_ip_addresses type="array"/>
<used_ip_address>
<ip_address>
<id type="integer">652</id>			
<address>109.123.105.147</address>
<prefix type="integer">16</prefix>
<broadcast>109.123.105.159</broadcast>
<network_address>109.123.105.144</network_address>
<gateway>109.123.105.145</gateway>
<created_at type="datetime">2012-07-25T21:49:41-10:00</created_at>
<updated_at type="datetime">2012-07-26T02:32:13-10:00</updated_at>
<ipv4 type="boolean">true</ipv4>
<user_id nil="true"/>
<hypervisor_id nil="true"/>
<ip_range_id type="integer">1</ip_range_id>
</ip_address>
</used_ip_address>
</used_ip_addresses>
</user>
<user>...</user>
</users> 


Where:

users - the array of users

user - the array of parameters for a user

activated_at – the date when the user was activated

avatar – the user's avatar

cdn_account_status – always returns ACTIVE status; but it is actually activated when CDN was enabled for particular user

cdn_status – whether CDN resources are enabled for this user or not

created_at – the date when the user was created, in [YYYY][MM][DD]T[hh][mm][ss]Z

deleted_at – the date when the user was deleted

email – the user's email

firewall_id – the ID of the firewall the user is associated with

first_name – the user's first name

group_id – the deprecated attribute; will be removed in upcoming release

id – the ID of a user in the database

identifier – the identifier of the user

image_template_group – the ID of associated template group, if any

infoboxes – the array of infoboxes with the following details:

hidden_infoboxes – the array of hidden infoboxes

hidden_infobox – the hash of a hidden inobox

display_infoboxes – true, if the infoboxes are displayed for this user, otherwise, false

last_name – the user's last name

locale – the locale (language) associated with user

login – the user's login name

Login parameter is not returned when API key is used for authentication instead of a login/password combination.

password_changed_at – the date when the user's password was changed in the [YYYY][MM][DD]T[hh][mm][ss]Z format

registered_yubikey – true, if the user has enabled logging in using a YubiKey, otherwise, false. To view the Yubikey(s) associated with a certain user, refer to Get List of User's YubiKeys. For the API request that adds a YubiKey, refer to Add YubiKey to User.

status – the status of the user's account (active, suspended, or deleted)

supplied – whether the user was created for the supplier when he published a zone to the Federation. If true, no actions can be performed on this user.

suspend_at – time when the system should suspend a user

system_theme – the color scheme of the interface: light or dark

time_zone – the time zone of the user

updated_at – time when user's profile data was updated

use_gravatar – true, if avatar is enabled for the user, otherwise false

user_group_id – ID of the user group assigned to this user

bucket_id – ID of the bucket assigned to this user

used_cpus – number of CPU cores allocated to all virtual servers and edge servers of the user

used_memory  the amount of RAM used by the user (MB)

used_cpu_shares – the amount of CPU shares used

used_disk_size – size of all user disks in GB

memory_available – the amount of RAM available to this user (MB)

disk_space_available – disk space available for the user (GB)

roles – an array of user roles to which this account is assigned to, where

created_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

id – the role ID

identifier – the role identifier

label – the role title

updated_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

permissions – an array with permissions assigned to this role

created_at  the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

id – permission ID

identifier – permission identifier

updated_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format


monthly_price – the monthly fee for the bucket usage

payment_amount – amount of money the user has actually paid

outstanding_amount – the amount of money the user is due to pay

total_amount – sum total of outstanding and payment amount

discount_due_to_free – the price of the resources that were created within the buckets' free limits

total_amount_with_discount – the price of used resources that excludes the cost of the resources that were created within the bucket's free limits

used_ip_addresses – an array of IP addresses associated with the user

additional field – user additional field, where:

value – the additional field value

name – the additional field title

used_ip_addresses – an array of IP address with the following parameters:

id – the ID of the IP address

address – the IP address

prefix – the prefix of the IP address

broadcast – the broadcast address

network_address – the address of the network

gateway – the gateway address

created_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

updated_at – the date when the network was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

network_id –the ID of the network

disallowed_primary – true if not allowed to be used as primary, otherwise false

customer_network_id - the ID of the customer VLAN the IP address belongs to

ipv4 - whether this is an IPv4 or and IPv6 IP address: `true` for IPv4 IPs and `false` for IPv6 IPs

user_id – the ID of a user associated with this IP address

hypervisor_id – the ID of a compute resource the IP address is associated with

ip_address_pool_id - ID of the IP address pool the IP address is associated with

ip_range_id - ID of the IP range the IP address is associated with

pxe - true, if this compute resource address can be used for a CloudBoot compute resource


Page History

v. 6.3 Edge 1

  • removed the billing_plan_id parameter

v. 6.0 

  • added the billing_plan_id parameter for the backward compatibility with billing plans