Get User Details

To get details for a particular user account, use the following request:

GET /users/:id.xml
GET /users/:id.json

XML Request Example

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

JSON Request Example

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

XML Output Example

<activated_at type="datetime">2012-04-03T14:30:34+00:00</activated_at>
<avatar nil="true"/>
<bucket_id type="integer">201</bucket_id>
<created_at type="datetime">2012-04-03T14:30:34+00:00</created_at>
<deleted_at nil="true"/>
<firewall_id type="integer">4</firewall_id>
<group_id nil="true"/>
<id type="integer">1</id>
<image_template_group_id nil="true"/>
<hidden_infoboxes type="array">
<display_infoboxes type="boolean">true</display_infoboxes>
<password_changed_at type="datetime">2014-08-21T16:00:15+03:00</password_changed_at>
<supplied type="boolean">false</supplied>
<suspend_at nil="true"/>
<total_amount type="float">83787.4296875</total_amount>
<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"/>
<outstanding_amount type="float">925.13000972271</outstanding_amount>
<payment_amount type="decimal">0.0</payment_amount>
<roles type="array">
<created_at type="datetime">2012-04-03T14:30:31+00:00</created_at>
<id type="integer">1</id>
<updated_at type="datetime">2012-04-20T10:28:32+00:00</updated_at>
<permissions type="array">
<created_at type="datetime">2012-04-03T14:30:31+00:00</created_at>
<id type="integer">110</id>
<label>Any action on autobackup templates</label>
<updated_at type="datetime">2012-04-03T14:30:31+00:00</updated_at>
<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>
<used_ip_addresses type="array"/>
<created_at type="datetime">2012-07-25T21:49:41-10:00</created_at>
<customer_network_id nil="true"/>
<disallowed_primary type="boolean">false</disallowed_primary>
<hypervisor_id nil="true"/>
<id type="integer">652</id>
<ip_address_pool_id nil="true"/>
<network_id type="integer">36</network_id>
<pxe type="boolean">false</pxe>
<updated_at type="datetime">2012-07-26T02:32:13-10:00</updated_at>
<user_id nil="true"/>
<free type="boolean">false</free>
<memory_available type="integer">3091</memory_available>
<disk_space_available type="integer">278</disk_space_available>
<cdn_reference type="integer">945453445</cdn_reference>
<additional_fields type="array">


activated_at – time when the user was activated

avatar – user's avatar

bucket_id – ID of the bucket assigned to this user

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 – time when the user was created, in [YYYY][MM][DD]T[hh][mm][ss]Z

deleted_at – time when the user was deleted

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

email – user's email

firewall_id the ID of the firewall the user is associated with

first_name – user's first name

group_id  deprecated attribute; will be removed in upcoming release

id — the ID of a user in the database

image_template_group – the ID of associated template group, if any

infoboxes - an array of infoboxes with the following details:

hidden_infoboxes - an array of hidden infoboxes

hidden_infobox - 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 – locale (language) associated with user

login – user's login name

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

monthly_price - monthly fee for bucket usage

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 – 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 color scheme of the interface: light or dark

time_zone – the time zone of the user

total_amount -  sum total of outstanding and payment amount

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.

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

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

payment_amount – amount of money the user has actually paid

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 – role ID

identifier – role identifier

label – 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

label – permission title

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

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

used_ip_addresses – an array of IP addresses associated with the user

ip_address - an array of IP address with the following parameters:

address - IP address

broadcast – broadcast address

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

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

disallowed_primary – true if not allowed to be used as primary (for VS build), otherwise false

gateway – gateway address

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

id – the ID of the IP address

ip_address_pool_id – the address of the IP address pool

network_address – the address of the network

network_id – the ID of the network

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

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

user_id – ID of a user associated with this IP address

free – true if free, otherwise false

netmask – netmask for the IP address

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

disk_space_available – disk space available for the user (GB)

additional field – user additional field, where:

value – the additional field value

name – the additional field title

Page History

v.6.3 Edge 1

  • removed billing_plan_id parameter