Maytech Public Documentation
Space shortcuts

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Default Value

Description

name

required

string

-

user name

email

required

string

-

user email address

groups

requiredstring

list of strings

-

the ID of the preferred users class (Pro Users and Associate Users)group

by default, there are 2 classes: Pro Users and Associate Users

Get /user/group

Code Block
languagejs
themeFadeToGrey
[
  {
    "id": "a7c8001f-bf3e-4afb-b8b5-7fdbb966a32f",
    "name": "Associate Users"
  },
  {
    "id": "b317d53e-4f04-41c1-92ca-a0b3a32d31af",
    "name": "Pro Users"
  }
]
user_operations

required

number-

user role - 3

secondary admin role - 1535

quota

optional

number-1

quota is measured in bytes (B)

"-1" means unlimited storage

language

optional

stringEnglish"en_GB"

"en_GB" - English

"zh_CN" - Chinese

services

optional

stringlist of strings-

to enable SFTP you need to specify its ID

Get /service - retrieves all services

Code Block
languagejs
themeFadeToGrey
"users": [

      {

        "email": "john.smith+78@maytech.net",

        "unique_login": "q4011239",

        "id": "525f81ca-f32b-4978-bfc5-abeb5f084584",

        "name": "New User"

      }

    ],

    "id": "52ecc90b-9f18-44db-89de-5549359739bb",

    "base": false,

    "key": "SFTP",

    "auth_methods": []

  }

]


custom_sftp_home

optional

booleanfalsetrue or false



Example Request URL

Request Payload

Code Block
languagejs
themeFadeToGrey
{
  "name": "New User",
  "email": "john.smith+78@maytech.net",
  "quota": -1,
  "user_operations": 3,
  "groups":
  [
  "b317d53e-4f04-41c1-92ca-a0b3a32d31af"
  ], 
"services":
  [
  "52ecc90b-9f18-44db-89de-5549359739bb"
  ]
}

...