Get List of Users (Short)

To view the list of users with short and fast output (without users' roles and permissions), use the following request:

GET /users.xml?short

GET /users.json?short

XML Request Example

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

JSON Request Example

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

XML Output Example

<users type="array">
 <user>
  <activated_at type="datetime">2015-06-08T06:03:19+00:00</activated_at>
  <avatar nil="true" />
  <cdn_account_status>ACTIVE</cdn_account_status>
  <cdn_status>INACTIVE</cdn_status>
  <created_at type="datetime">2015-06-08T06:03:18+00:00</created_at>
  <deleted_at nil="true" />
  <email>admin@example.com</email>
  <firewall_id nil="true" />
  <first_name>John</first_name>
  <group_id nil="true" />
  <id type="integer">1</id>
  <identifier>e0ooz1qgipur9p</identifier>
  <image_template_group_id nil="true" />
  <infoboxes>
    <display_infoboxes type="boolean">true</display_infoboxes>
	<hidden_infoboxes type="array" />
  </infoboxes>
  <last_name>Smith</last_name>
  <locale>en</locale>
  <login>admin</login>
  <password_changed_at type="datetime">2015-06-08T06:03:18+00:00</password_changed_at>
  <registered_yubikey type="boolean">false</registered_yubikey>
  <status>active</status>
  <supplied type="boolean">false</supplied>
  <suspend_at nil="true" />
  <system_theme></system_theme>
  <time_zone>Kyiv</time_zone>
  <updated_at type="datetime">2015-06-10T10:39:34+00:00</updated_at>
  <use_gravatar nil="true" />
  <user_group_id nil="true" />
  <bucket_id type="integer">7</bucket_id>
  <monthly_price type="decimal">0.0</monthly_price>
  <payment_amount type="decimal">0.0</payment_amount>
  <outstanding_amount type="decimal">0.0</outstanding_amount>
  <total_amount type="float">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>
 </user>
</users>

Where:

users – the array of users

user – the array of parameters for the 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 a particular user

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

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

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 that 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 the 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 infobox

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

The login parameter is not returned when an 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 – the date when the system can suspend a user in the [YYYY][MM][DD]T[hh][mm][ss]Z format

system_theme – the color scheme of the interface that can be light or dark

time_zone – the time zone of the user

updated_at – the date when the user's profile data was updated

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

user_group_id – the ID of the user group assigned to this user

bucket_id – the ID of the bucket assigned to this user

monthly_price – the monthly fee for the bucket usage

payment_amount – the amount of money the user paid for consumed resources

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

total_amount – the 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

Page History

v. 6.3 Edge 1

removed billing_plan_id parameter

v. 6.0

added the billing_plan_id parameter for the backward compatibility with billing plans