Overview
Error Handling

Methods

API Documentation (API Version bleed)

Account/User/

DESCRIPTION

This section contains methods to manage the various users an account contains. This includes both StormOnDemand.com users and api users.

available

URL:

https://api.liquidweb.com/bleed/Account/User/available

Description:

This method can be used to determine whether a username is currently available.

Parameters:

ParameterTypeNotes
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldType
availableA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

canLogin

URL:

https://api.liquidweb.com/bleed/Account/User/canLogin

Description:

DEPRECATED METHOD: Currently always returns {can_login => 1}, since we no longer have separate Storm and LiquidWeb brands.

Previously: Does some additional scrutiny on an user to make sure it can log in to the management interface it's attempting to log in to.

Parameters:

ParameterType
brandA single word, consisting of only letters and digits.

Returns:

FieldType
can_loginA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

create

URL:

https://api.liquidweb.com/bleed/Account/User/create

Description:

Creates a new user with the role designated. This user will immediately be able to login and access the functions appropriate to their role.

Parameters:

ParameterTypeNotes
emailA valid email address.* Required
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.* Required
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.* Required
passwordA password of at least 6 characters and up to 100 characters in length, may contain spaces* Required
rolesAn array of a role name, containing only letters, up to 100 characters in length.* Required
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
emailA valid email address.
federation_idA contiguous string of non-space printable characters* Optional
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
nameA string of text, containing no newlines or other control characters.
rolesAn array of a role name, containing only letters, up to 100 characters in length.
suspendedA boolean value (0 or 1).
tfa_enabledA boolean value (0 or 1).
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delete

URL:

https://api.liquidweb.com/bleed/Account/User/delete

Description:

Deletes an existing user. While the user has been deleted, the username will not be available for use in new user creates.

Parameters:

ParameterTypeNotes
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
emailA valid email address.
federation_idA contiguous string of non-space printable characters* Optional
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
nameA string of text, containing no newlines or other control characters.
rolesAn array of a role name, containing only letters, up to 100 characters in length.
suspendedA boolean value (0 or 1).
tfa_enabledA boolean value (0 or 1).
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.liquidweb.com/bleed/Account/User/details

Description:

Get information about a specific user on this account.

Parameters:

ParameterTypeNotes
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
emailA valid email address.
federation_idA contiguous string of non-space printable characters* Optional
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
nameA string of text, containing no newlines or other control characters.
rolesAn array of a role name, containing only letters, up to 100 characters in length.
suspendedA boolean value (0 or 1).
tfa_enabledA boolean value (0 or 1).
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

generateAPIUser

URL:

https://api.liquidweb.com/bleed/Account/User/generateAPIUser

Description:

Generates a new API token-based user with the roles designated. This user will immediately be able to access the API

Parameters:

ParameterTypeNotes
rolesAn array of a role name, containing only letters, up to 100 characters in length.* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
emailA valid email address.
federation_idA contiguous string of non-space printable characters* Optional
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
nameA string of text, containing no newlines or other control characters.
rolesAn array of a role name, containing only letters, up to 100 characters in length.
suspendedA boolean value (0 or 1).
tfa_enabledA boolean value (0 or 1).
tokenA password of at least 6 characters and up to 100 characters in length, may contain spaces
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

generateAPIUserToken

URL:

https://api.liquidweb.com/bleed/Account/User/generateAPIUserToken

Description:

Generates a new token for the specified API token-based user. This change has an immediate effect on the user and any action on the API where the previously assigned token is used will be denied.

Parameters:

ParameterTypeNotes
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
emailA valid email address.
federation_idA contiguous string of non-space printable characters* Optional
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
nameA string of text, containing no newlines or other control characters.
rolesAn array of a role name, containing only letters, up to 100 characters in length.
suspendedA boolean value (0 or 1).
tfa_enabledA boolean value (0 or 1).
tokenA password of at least 6 characters and up to 100 characters in length, may contain spaces
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.liquidweb.com/bleed/Account/User/list

Description:

Get a list of the current users for this account.

Parameters:

ParameterTypeNotes
activeA boolean value (0 or 1).
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
activeA boolean value (0 or 1).
emailA valid email address.
federation_idA contiguous string of non-space printable characters* Optional
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
nameA string of text, containing no newlines or other control characters.
rolesAn array of a role name, containing only letters, up to 100 characters in length.
suspendedA boolean value (0 or 1).
tfa_enabledA boolean value (0 or 1).
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

permitted

URL:

https://api.liquidweb.com/bleed/Account/User/permitted

Description:

Determines whether the authenticated user has access to other API methods.

Can check if the user is permitted for either API actions or permissions actions. If neither is specified, a best guess attempt is made to determine which.

Be aware that if no actions are specified and "permissions" is set as the action type, no useful data will be returned.

Parameters:

ParameterType
action_typeOne of: 'api', 'permissions'
actionsAn array of an ltree-based action name, such as Permissions.User.Delete

Returns:

FieldType
permissionsAn associative array of arbitrary keys and values.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

roles

URL:

https://api.liquidweb.com/bleed/Account/User/roles

Description:

Gets a list of available roles.

Parameters:

No Values Defined

Returns:

FieldType
rolesAn array of a role name, containing only letters, up to 100 characters in length.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.liquidweb.com/bleed/Account/User/update

Description:

Updates an existing user.

Parameters:

ParameterTypeNotes
activeA boolean value (0 or 1).
emailA valid email address.
existing_userA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
passwordA password of at least 6 characters and up to 100 characters in length, may contain spaces
rolesAn array of a role name, containing only letters, up to 100 characters in length.
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
emailA valid email address.
federation_idA contiguous string of non-space printable characters* Optional
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
nameA string of text, containing no newlines or other control characters.
rolesAn array of a role name, containing only letters, up to 100 characters in length.
suspendedA boolean value (0 or 1).
tfa_enabledA boolean value (0 or 1).
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types