/api/reseller/users/create

PUT

/api/reseller/users/create

curl --request PUT \
  --url https://dashboard.residential.rayobyte.com/api/reseller/users/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "my-test-email@example.com", "login": "test-user1", "password": "6mEAtE25", "description": "SERP scraping" }'

• Main API host

Allows a Reseller to create an account for a proxy Sub-user

The endpoint is designed to create a Sub-user account (user of the proxy service) in the system database. The minimum set of data that needs to be transferred to the system to create a new account is as follows: unique email, unique login (will be used to access proxy service), password (will be used to access proxy service). The user is created with zero balance and inactive status. In order for a user to be able to start using proxy services, you must first add traffic to his balance, and then activate it (see Add Bandwidth and Activate User endpoints).

Important! The password must be stored in advance for transmission to the end user, since it is stored in the database in an encrypted form and cannot be retrieved later.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

email

required

Proxy User email.

string

/^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/

login

required

Unique Proxy User login. Will be used for accessing proxy servers

string

>= 2 characters <= 64 characters

password

required

Proxy User account password. Will be used for accessing proxy servers as well as the dashboard

string

>= 5 characters <= 64 characters

description

Short description of the account.

string

>= 2 characters <= 1024 characters

Examples

Valid input example

{
  "email": "my-test-email@example.com",
  "login": "test-user1",
  "password": "6mEAtE25",
  "description": "SERP scraping"
}

Passed user email is invalid

{
  "email": "my-test-email",
  "login": "test-user1",
  "password": "6mEAtE25"
}

Invalid authorization data (account does not exist or access token is expired)

Not authorized.

Responses

200

Proxy User account is successfully created

Media typeapplication/json

object

status

string

Allowed values: SUCCESS

date

string

userId

string

Examples

ExampleSuccess

Proxy User is successfully created

{
  "status": "SUCCESS",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "userId": "c747fef9-d2e1-4500-b6b0-31c026955f92"
}

401

Not authorized

Media typetext/html

string

Examples

ExampleNot authorized

Not authorized

Not authorized.

500

API call failed

Media typeapplication/json

object

status

string

Allowed values: FAIL

date

string

error

string

Examples

ExampleInternal error

An unexpected error occurred while processing the request.

{
  "status": "FAIL",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "error": "Internal server error"
}