user

Manage users

Available_ips

Path: GET /v7.0/users/{user_id}/available_ips
Description: Get number of user-owned free IP addresses that can be used in a given location
Authentication required: yes
Scope: user#available_ips
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: user

Parameter	Type	Required	Details
`location` Location	Resource	yes	Location where the VPS will run
`address_location` Address location	Resource	no	Location to select IP addresses from

Output parameters

Layout: hash
Namespace: user

Parameter	Type	Description
`ipv4` IPv4	Integer
`ipv4_private` Private IPv4	Integer
`ipv6` IPv6	Integer

Create

Path: POST /v7.0/users
Description: Create new user
Authentication required: yes
Scope: user#create
Aliases: new
Blocking: yes

Input parameters

Layout: object
Namespace: user

Parameter Type Required Details

login

String

Default: null

Validation rules
Rule	Details
Format	Must match this regular expression: `\A[a-zA-Z0-9.-]{2,63}\z` `null` Validation error message: not a valid login

full_name

Full name

String

First and last name

Default: null

email

E-mail

String

Administrator of this zone

Default: null

address

Address

String

Default: null

time_zone

Time zone

String

IANA time zone identifier, e.g. Europe/Prague

Default: null

level

Access level

Integer

Default: null

info

Info

String

Default: null

mailer_enabled

Enabled mailer

Boolean

Default: true

password_reset

Password reset

Boolean

Default: null

lockout

Lock-out

Boolean

Default: null

language

Language of e-mails

Resource

enable_basic_auth

Enable HTTP basic authentication

Boolean

Default: null

enable_token_auth

Enable token authentication

Boolean

Default: null

enable_oauth2_auth

Enable OAuth2 authentication

Boolean

Default: null

enable_single_sign_on

Enable single sign-on

Boolean

Default: null

enable_new_login_notification

Enable new login notification

Boolean

Default: null

enable_multi_factor_auth

Enable multi-factor authentication

Boolean

Default: null

preferred_session_length

Preferred session length

Integer

Default: null

preferred_logout_all

Preferred logout all

Boolean

Default: null

password

Password

String

The password must be at least 8 characters long

Default: null

vps

Create a VPS

Boolean

Default: null

node

Node

Resource

Node VPS will run on

environment

Environment

Resource

Environment in which to create the VPS

location

Location

Resource

Location in which to create the VPS

os_template

OS template

Resource

Output parameters

Layout: object
Namespace: user

Parameter	Type	Description
`id` User ID	Integer
`login` Login	String
`full_name` Full name	String	First and last name
`email` E-mail	String	Administrator of this zone
`address` Address	String
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`level` Access level	Integer
`info` Info	String
`mailer_enabled` Enabled mailer	Boolean
`password_reset` Password reset	Boolean
`lockout` Lock-out	Boolean
`language` Language of e-mails	Resource
`enable_basic_auth` Enable HTTP basic authentication	Boolean
`enable_token_auth` Enable token authentication	Boolean
`enable_oauth2_auth` Enable OAuth2 authentication	Boolean
`enable_single_sign_on` Enable single sign-on	Boolean
`enable_new_login_notification` Enable new login notification	Boolean
`enable_multi_factor_auth` Enable multi-factor authentication	Boolean
`preferred_session_length` Preferred session length	Integer
`preferred_logout_all` Preferred logout all	Boolean
`last_activity_at` Last activity	Datetime
`dokuwiki_groups` DokuWiki groups	String	Comma-separated list of DokuWiki groups
`created_at` Created at	Datetime
`object_state` Object state	String
`expiration_date` Expiration	Datetime	A date after which the state will progress
`remind_after_date` Remind after	Datetime	Mail warnings are silenced until this date

Current

Path: GET /v7.0/users/current
Description: Get user that is authenticated during this request
Authentication required: yes
Scope: user#current
Aliases
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: user

Parameter	Type	Description
`id` User ID	Integer
`login` Login	String
`full_name` Full name	String	First and last name
`email` E-mail	String	Administrator of this zone
`address` Address	String
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`level` Access level	Integer
`info` Info	String
`mailer_enabled` Enabled mailer	Boolean
`password_reset` Password reset	Boolean
`lockout` Lock-out	Boolean
`language` Language of e-mails	Resource
`enable_basic_auth` Enable HTTP basic authentication	Boolean
`enable_token_auth` Enable token authentication	Boolean
`enable_oauth2_auth` Enable OAuth2 authentication	Boolean
`enable_single_sign_on` Enable single sign-on	Boolean
`enable_new_login_notification` Enable new login notification	Boolean
`enable_multi_factor_auth` Enable multi-factor authentication	Boolean
`preferred_session_length` Preferred session length	Integer
`preferred_logout_all` Preferred logout all	Boolean
`last_activity_at` Last activity	Datetime
`dokuwiki_groups` DokuWiki groups	String	Comma-separated list of DokuWiki groups
`created_at` Created at	Datetime
`object_state` Object state	String
`expiration_date` Expiration	Datetime	A date after which the state will progress
`remind_after_date` Remind after	Datetime	Mail warnings are silenced until this date
`monthly_payment` Monthly payment	Integer
`paid_until` Paid until	Datetime

Delete

Path: DELETE /v7.0/users/{user_id}
Description
Authentication required: yes
Scope: user#delete
Aliases: destroy
Blocking: yes

Input parameters

Layout: object
Namespace: user

Parameter Type Required Details

object_state

Object state

String

Default: soft_delete

Validation rules
Rule	Details
Include	Allowed values: `soft_delete` `hard_delete` `deleted` Validation error message: %{value} cannot be used

expiration_date

Expiration

Datetime

A date after which the state will progress

Default: null

remind_after_date

Remind after

Datetime

Mail warnings are silenced until this date

Default: null

change_reason

Reason

String

Reason for the state change. May be mailed to the user.

Default: null

Output parameters

No parameters.

Get_payment_instructions

Path: GET /v7.0/users/{user_id}/get_payment_instructions
Description
Authentication required: yes
Scope: user#get_payment_instructions
Aliases
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: hash
Namespace: user

Parameter	Type	Description
`instructions` Instructions	String

Index

Path: GET /v7.0/users
Description: List users
Authentication required: yes
Scope: user#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: user

Parameter Type Required Details

from_id

From ID

Integer

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Validation error message: must be at least 0

limit

Limit

Integer

Number of objects to retrieve

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Maximum: `1000` (inclusive). Validation error message: must be between 0 and 1000

login

String

Default: null

Validation rules
Rule	Details
Format	Must match this regular expression: `\A[a-zA-Z0-9.-]{2,63}\z` `null` Validation error message: not a valid login

full_name

Full name

String

First and last name

Default: null

email

E-mail

String

Administrator of this zone

Default: null

address

Address

String

Default: null

time_zone

Time zone

String

IANA time zone identifier, e.g. Europe/Prague

Default: null

level

Access level

Integer

Default: null

info

Info

String

Default: null

mailer_enabled

Enabled mailer

Boolean

Default: true

password_reset

Password reset

Boolean

Default: null

lockout

Lock-out

Boolean

Default: null

language

Language of e-mails

Resource

enable_basic_auth

Enable HTTP basic authentication

Boolean

Default: null

enable_token_auth

Enable token authentication

Boolean

Default: null

enable_oauth2_auth

Enable OAuth2 authentication

Boolean

Default: null

enable_single_sign_on

Enable single sign-on

Boolean

Default: null

enable_new_login_notification

Enable new login notification

Boolean

Default: null

enable_multi_factor_auth

Enable multi-factor authentication

Boolean

Default: null

preferred_session_length

Preferred session length

Integer

Default: null

preferred_logout_all

Preferred logout all

Boolean

Default: null

admin

Admin

Boolean

Filter users with administrator privileges

Default: null

object_state

Object state

String

Default: null

Validation rules
Rule	Details
Include	Allowed values: `active`: Active `suspended`: Suspended `soft_delete`: Soft delete `hard_delete`: Hard delete `deleted`: Deleted Validation error message: %{value} cannot be used

Output parameters

Layout: object_list
Namespace: users

Parameter	Type	Description
`id` User ID	Integer
`login` Login	String
`full_name` Full name	String	First and last name
`email` E-mail	String	Administrator of this zone
`address` Address	String
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`level` Access level	Integer
`info` Info	String
`mailer_enabled` Enabled mailer	Boolean
`password_reset` Password reset	Boolean
`lockout` Lock-out	Boolean
`language` Language of e-mails	Resource
`enable_basic_auth` Enable HTTP basic authentication	Boolean
`enable_token_auth` Enable token authentication	Boolean
`enable_oauth2_auth` Enable OAuth2 authentication	Boolean
`enable_single_sign_on` Enable single sign-on	Boolean
`enable_new_login_notification` Enable new login notification	Boolean
`enable_multi_factor_auth` Enable multi-factor authentication	Boolean
`preferred_session_length` Preferred session length	Integer
`preferred_logout_all` Preferred logout all	Boolean
`last_activity_at` Last activity	Datetime
`dokuwiki_groups` DokuWiki groups	String	Comma-separated list of DokuWiki groups
`created_at` Created at	Datetime
`object_state` Object state	String
`expiration_date` Expiration	Datetime	A date after which the state will progress
`remind_after_date` Remind after	Datetime	Mail warnings are silenced until this date
`monthly_payment` Monthly payment	Integer
`paid_until` Paid until	Datetime

Show

Path: GET /v7.0/users/{user_id}
Description
Authentication required: yes
Scope: user#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: user

Parameter	Type	Description
`id` User ID	Integer
`login` Login	String
`full_name` Full name	String	First and last name
`email` E-mail	String	Administrator of this zone
`address` Address	String
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`level` Access level	Integer
`info` Info	String
`mailer_enabled` Enabled mailer	Boolean
`password_reset` Password reset	Boolean
`lockout` Lock-out	Boolean
`language` Language of e-mails	Resource
`enable_basic_auth` Enable HTTP basic authentication	Boolean
`enable_token_auth` Enable token authentication	Boolean
`enable_oauth2_auth` Enable OAuth2 authentication	Boolean
`enable_single_sign_on` Enable single sign-on	Boolean
`enable_new_login_notification` Enable new login notification	Boolean
`enable_multi_factor_auth` Enable multi-factor authentication	Boolean
`preferred_session_length` Preferred session length	Integer
`preferred_logout_all` Preferred logout all	Boolean
`last_activity_at` Last activity	Datetime
`dokuwiki_groups` DokuWiki groups	String	Comma-separated list of DokuWiki groups
`created_at` Created at	Datetime
`object_state` Object state	String
`expiration_date` Expiration	Datetime	A date after which the state will progress
`remind_after_date` Remind after	Datetime	Mail warnings are silenced until this date
`monthly_payment` Monthly payment	Integer
`paid_until` Paid until	Datetime

Touch

Path: GET /v7.0/users/{user_id}/touch
Description: Update last activity
Authentication required: yes
Scope: user#touch
Aliases
Blocking: no

Input parameters

No parameters.

Output parameters

No parameters.

Update

Path: PUT /v7.0/users/{user_id}
Description
Authentication required: yes
Scope: user#update
Aliases
Blocking: yes

Input parameters

Layout: object
Namespace: user

Parameter Type Required Details

login

String

Default: null

Validation rules
Rule	Details
Format	Must match this regular expression: `\A[a-zA-Z0-9.-]{2,63}\z` `null` Validation error message: not a valid login

full_name

Full name

String

First and last name

Default: null

email

E-mail

String

Administrator of this zone

Default: null

address

Address

String

Default: null

time_zone

Time zone

String

IANA time zone identifier, e.g. Europe/Prague

Default: null

level

Access level

Integer

Default: null

info

Info

String

Default: null

mailer_enabled

Enabled mailer

Boolean

Default: true

password_reset

Password reset

Boolean

Default: null

lockout

Lock-out

Boolean

Default: null

language

Language of e-mails

Resource

enable_basic_auth

Enable HTTP basic authentication

Boolean

Default: null

enable_token_auth

Enable token authentication

Boolean

Default: null

enable_oauth2_auth

Enable OAuth2 authentication

Boolean

Default: null

enable_single_sign_on

Enable single sign-on

Boolean

Default: null

enable_new_login_notification

Enable new login notification

Boolean

Default: null

enable_multi_factor_auth

Enable multi-factor authentication

Boolean

Default: null

preferred_session_length

Preferred session length

Integer

Default: null

preferred_logout_all

Preferred logout all

Boolean

Default: null

password

Current password

String

The password must be at least 8 characters long

Default: null

new_password

Password

String

The password must be at least 8 characters long

Default: null

logout_sessions

Logout sessions

Boolean

Logout all sessions except the current one when password is changed

Default: true

object_state

Object state

String

Default: null

Validation rules
Rule	Details
Include	Allowed values: `active`: Active `suspended`: Suspended `soft_delete`: Soft delete `hard_delete`: Hard delete `deleted`: Deleted Validation error message: %{value} cannot be used

expiration_date

Expiration

Datetime

A date after which the state will progress

Default: null

remind_after_date

Remind after

Datetime

Mail warnings are silenced until this date

Default: null

change_reason

Reason

String

Reason for the state change. May be mailed to the user.

Default: null

Output parameters

Layout: object
Namespace: user

Parameter	Type	Description
`id` User ID	Integer
`login` Login	String
`full_name` Full name	String	First and last name
`email` E-mail	String	Administrator of this zone
`address` Address	String
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`level` Access level	Integer
`info` Info	String
`mailer_enabled` Enabled mailer	Boolean
`password_reset` Password reset	Boolean
`lockout` Lock-out	Boolean
`language` Language of e-mails	Resource
`enable_basic_auth` Enable HTTP basic authentication	Boolean
`enable_token_auth` Enable token authentication	Boolean
`enable_oauth2_auth` Enable OAuth2 authentication	Boolean
`enable_single_sign_on` Enable single sign-on	Boolean
`enable_new_login_notification` Enable new login notification	Boolean
`enable_multi_factor_auth` Enable multi-factor authentication	Boolean
`preferred_session_length` Preferred session length	Integer
`preferred_logout_all` Preferred logout all	Boolean
`last_activity_at` Last activity	Datetime
`dokuwiki_groups` DokuWiki groups	String	Comma-separated list of DokuWiki groups
`created_at` Created at	Datetime

user#

Available_ips#

Input parameters#

Output parameters#

Create#

Input parameters#

Output parameters#

Current#

Input parameters#

Output parameters#

Delete#

Input parameters#

Output parameters#

Get_payment_instructions#

Input parameters#

Output parameters#

Index#

Input parameters#

Output parameters#

Show#

Input parameters#

Output parameters#

Touch#

Input parameters#

Output parameters#

Update#

Input parameters#

Output parameters#

Subresources#

user

Available_ips

Input parameters

Output parameters

Create

Input parameters

Output parameters

Current

Input parameters

Output parameters

Delete

Input parameters

Output parameters

Get_payment_instructions

Input parameters

Output parameters

Index

Input parameters

Output parameters

Show

Input parameters

Output parameters

Touch

Input parameters

Output parameters

Update

Input parameters

Output parameters

Subresources