POST
Update sub-user

Authorizations

Authorization
string
header
required

[just text field] Please enter token in following format: Bearer

Body

application/json
userId
string
required

The userId (username) of the sub-user to update.

Example:

"test124"

dataGb
number
required

Amount, in GB, to adjust the sub-user's current data allocation by. Use a positive value to add data or a negative value to subtract data.

Example:

2

Response

User updated

username
string
required

Username of the sub-user

Example:

"test124"

userId
string
required

Unique identifier of the sub-user (same value as username)

Example:

"test124"

password
string
required

Current password of the sub-user

dataLimit
number
required

Total data allocated to the sub-user, in GB

Example:

5

dataUsed
number
required

Amount of data used by the sub-user so far, in GB

Example:

1.2

dataRemaining
number
required

Amount of data remaining for the sub-user, in GB (dataLimit minus dataUsed)

Example:

3.8

status
enum<string>
required

Current status of the sub-user

Available options:
active,
inactive
Example:

"active"

dateCreated
string<date-time>
required

Date and time the sub-user was created

whitelistedIps
string[]
required

List of IP addresses whitelisted for the sub-user

Example: