hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
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.
adjustAcls
URL:
https://api.liquidweb.com/bleed/Account/User/adjustAcls
Description:
Parameters:
| Parameter | Type | Notes | ||
|---|---|---|---|---|
| add | One of the following: | * Required if:
| ||
| ||||
| remove | One of the following: | * Required if:
| ||
| ||||
| username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Required | ||
Returns:
| Field | Type | Notes |
|---|---|---|
| added | An array of arbitrary values. | * Optional |
| removed | An array of arbitrary values. | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
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:
| Parameter | Type | Notes |
|---|---|---|
| username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Required |
Returns:
| Field | Type |
|---|---|
| available | A 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:
| Parameter | Type |
|---|---|
| brand | A single word, consisting of only letters and digits. |
Returns:
| Field | Type |
|---|---|
| can_login | A 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:
| Parameter | Type | Notes |
|---|---|---|
| A valid email address. | * Required | |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | * Required |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | * Required |
| password | A password of at least 6 characters and up to 100 characters in length, may contain spaces | * Required |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | * Required |
| username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| acls | An array of arbitrary values. | * Optional |
| active | A boolean value (0 or 1). | |
| A valid email address. | ||
| federation_id | A contiguous string of non-space printable characters | * Optional |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| name | A string of text, containing no newlines or other control characters. | |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | |
| suspended | A boolean value (0 or 1). | |
| tfa_enabled | A boolean value (0 or 1). | |
| username | A 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:
| Parameter | Type | Notes |
|---|---|---|
| username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| acls | An array of arbitrary values. | * Optional |
| active | A boolean value (0 or 1). | |
| A valid email address. | ||
| federation_id | A contiguous string of non-space printable characters | * Optional |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| name | A string of text, containing no newlines or other control characters. | |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | |
| suspended | A boolean value (0 or 1). | |
| tfa_enabled | A boolean value (0 or 1). | |
| username | A 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:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of The value: 'acls' | |
| username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| acls | An array of arbitrary values. | * Optional |
| active | A boolean value (0 or 1). | |
| A valid email address. | ||
| federation_id | A contiguous string of non-space printable characters | * Optional |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| name | A string of text, containing no newlines or other control characters. | |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | |
| suspended | A boolean value (0 or 1). | |
| tfa_enabled | A boolean value (0 or 1). | |
| username | A 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:
| Parameter | Type | Notes |
|---|---|---|
| roles | An array of a role name, containing only letters, up to 100 characters in length. | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| acls | An array of arbitrary values. | * Optional |
| active | A boolean value (0 or 1). | |
| A valid email address. | ||
| federation_id | A contiguous string of non-space printable characters | * Optional |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| name | A string of text, containing no newlines or other control characters. | |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | |
| suspended | A boolean value (0 or 1). | |
| tfa_enabled | A boolean value (0 or 1). | |
| token | A password of at least 6 characters and up to 100 characters in length, may contain spaces | |
| username | A 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:
| Parameter | Type | Notes |
|---|---|---|
| username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| acls | An array of arbitrary values. | * Optional |
| active | A boolean value (0 or 1). | |
| A valid email address. | ||
| federation_id | A contiguous string of non-space printable characters | * Optional |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| name | A string of text, containing no newlines or other control characters. | |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | |
| suspended | A boolean value (0 or 1). | |
| tfa_enabled | A boolean value (0 or 1). | |
| token | A password of at least 6 characters and up to 100 characters in length, may contain spaces | |
| username | A 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:
| Parameter | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| alsowith | An array of The value: 'acls' | |
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
Returns:
| Field | Type | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_count | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||||||||||||||
| item_total | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||||||||||||||
| items | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
| page_num | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||||||||
| page_size | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||||||||
| page_total | A 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:
| Parameter | Type |
|---|---|
| action_type | One of: 'api', 'permissions' |
| actions | An array of an ltree-based action name, such as Permissions.User.Delete |
Returns:
| Field | Type |
|---|---|
| permissions | An 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:
| Field | Type |
|---|---|
| roles | An 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:
| Parameter | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| A valid email address. | ||
| existing_user | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Required |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| password | A password of at least 6 characters and up to 100 characters in length, may contain spaces | |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | |
| username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). |
Returns:
| Field | Type | Notes |
|---|---|---|
| acls | An array of arbitrary values. | * Optional |
| active | A boolean value (0 or 1). | |
| A valid email address. | ||
| federation_id | A contiguous string of non-space printable characters | * Optional |
| firstname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| lastname | The first, middle, or last name of an individual, up to 50 characters in length. | |
| name | A string of text, containing no newlines or other control characters. | |
| roles | An array of a role name, containing only letters, up to 100 characters in length. | |
| suspended | A boolean value (0 or 1). | |
| tfa_enabled | A boolean value (0 or 1). | |
| username | A 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
