hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/Auth/
- Account/SSH/Key/
- Account/User/
- Billing/Invoice/
- Billing/Payment/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Server/
- Cloud/Template/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/Services/
- Network/DNS/Domain/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/Zone/
- Notifications/
- Order/AddOn/
- Product/
- Server/
- Server/VirtualDomain/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Support/Alert/
- Utilities/Info/
- VIP/
- VPN/
API Documentation (API Version v1)
Account/User/
DESCRIPTION
This section contains methods to manage the various users an account contains. This includes both StormOnDemand.com users and api users.
permitted
URL:
https://api.liquidweb.com/v1/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 |
| all | A boolean value (0 or 1). Whether or not to return all results even if they are denied |
| as_endpoints | A boolean value (0 or 1). Return the results formatted as paths to API endpoints |
| version | One of: 'bleed', 'v1', 'v2', 'v3' If a version is specified, only return API actions specific to that version |
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