Powered by Redocly

Master - Auth

Login

To obtain the access token of the master portal, email address and password are required.

Please be noticed, The access token of fleet and master account are separated

Therefor you can't access Master endpoints with Fleet access token, and vice versa.

Securityapi key
Request
Request Body schema:
email
required
string <email> non-empty
password
required
string >= 6 characters
type
required
string non-empty

Login type, accept email only

udid
string or null

A randomly generated string, preferably using UUIDv4 but not limited to UUIDv4.

This is UI-related. The system uses this unique string to track and store preferences; therefore, you can omit it or leave it empty if the client is not related to the UI.

Responses
200

OK

post/portal/V1/auth
Request samples
{
  • "email": "user@example.com",
  • "password": "string",
  • "type": "email",
  • "udid": ""
}

Log out

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/logout

Token verify

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/auth/token-verify

Get fleet's access token

Get a short-term access token for specified fleet

Securityapi key and Authorization
Request
Request Body schema: multipart/form-data
fleet_id
required
integer <int32>

The fleet id

expire_at
integer <int32>

TTL of the delegate token.

Maxium TTL is 86400

Responses
200

OK

post/portal/V1/auth/fleet-delegate
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "token": "string"
}
➔ Next to Master - Dashboard