Get JWT token

Get a JWT token to authenticate with the API.

post/api-login

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
none required
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api-login/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

usernamestring required

Username or e-mail address

passwordstring required

Password

uuidstring

Evaluation user UUID

ssoType'browser' | 'cli'

sessionIdstring

Session ID

totpTokenstring

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.

Example request

{
  "username": "edge-user-01"
}

Response

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

tokenstring

JWT token, to be used to log in in the future through JWTAuthentication

redirectUrlstring

Redirect URL to follow to complete login

Changes

No recorded changes to this operation across all 1 revision of this API.