Get authentication token

post https://{sandfly-api-host}/v4/auth/login

Gets the authentication token.

Responses

Response body

object

access_token

string

required

Access token.

access_token_data

object

required

Access JWT data decoded.

exp

int64

Expiration time of the token.

sxp

int64

Expiration time of the session.

fresh

boolean

Is the token fresh?

iat

int64

Issued at time of the token.

jti

string

JWT ID.

nbf

int64

Not before time of the token.

sub

string

Subject of the token.

type

string

Type of the token.

access_token_expire_date

string

required

Access token expire date.

access_token_issue_date

string

required

Access token issue date.

llm

object

required

Current LLM configuration

enabled

boolean

required

LLM analysis is enabled.

results_limit

integer

required

Maximum number of results allowed in an LLM analysis request.

refresh_token

string

required

Refresh token.

refresh_token_data

object

required

Refresh JWT data decoded.

exp

int64

Expiration time of the token.

sxp

int64

Expiration time of the session.

fresh

boolean

Is the token fresh?

iat

int64

Issued at time of the token.

jti

string

JWT ID.

nbf

int64

Not before time of the token.

sub

string

Subject of the token.

type

string

Type of the token.

refresh_token_expire_date

string

required

Refresh token expire date.

refresh_token_issue_date

string

required

Refresh token issue date.

user

object

required

created_date

date-time

required

Date this user was created

string

required

Email address for the user.

full_name

string

required

Full name of user.

last_login_date

date-time | null

required

Last login date/time for this user.

last_login_ip

string

required

Last login IP address we saw this user.

logins

array of strings

required

An comma delimited array of the dates and locations this user has ever logged in from.

logins*

logins_failed

array of strings

required

An comma delimited array of the dates and locations this user has failed logged in from.

logins_failed*

logins_failed_count

int64

required

A counter of the number of failed logins from the last successful login. Used to detect brute forcers.

password

string

required

User's password (used for setting during creation; not returned)

preferences

string

required

Preferences for user.

roles

array

required

Roles this user has access to.

roles*

sso

boolean

required

False for a local Sandfly user, true for an SSO user. Cannot change once user is created.

username

string

required

Username

saved_views

array of objects

required

saved_views*

object

name

string

required

Name of the saved view.

namespace

string

required

Namespace of the table that the view is applied to.

view

string

required

JSON string of the view. For internal use by the Sandfly UI only.

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandfly-api-host/v4/auth/login \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Login valid

400Error during login

401Invalid login

defaultUnexpected error