Get JWT token | Edge Impulse API and SDKs Documentation

Home DocsForum Studio

post

Get a JWT token to authenticate with the API.

Body

usernamestringrequired

Username or e-mail address

Example: edge-user-01

passwordstringrequired

Password

uuidstringoptional

Evaluation user UUID

ssoTypestring · enumoptionalAvailable options:

sessionIdstringoptional

Session ID

totpTokenstringoptional

TOTP Token. Required if a user has multi-factor authentication with a TOTP token enabled. If a user has MFA enabled, but no totpToken is submitted; then an error starting with "ERR_TOTP_TOKEN IS REQUIRED" is returned. Use this to then prompt for an MFA token and re-login.

Responses

application/json

all ofoptionalExample: `{ "success": true, "token": "A372jdhe.ad3r4gfrg" }`

post

POST /v1/api-login HTTP/1.1
Host: studio.edgeimpulse.com
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "username": "edge-user-01",
  "password": "text",
  "uuid": "text",
  "ssoType": "browser",
  "sessionId": "text",
  "totpToken": "text"
}

200

`{ "success": true, "token": "A372jdhe.ad3r4gfrg" }`