Auth Actions

https://api.losant.com/auth

Below are the various requests that can be performed against the Auth resource, as well as the expected parameters and the potential responses.

Authenticate Device

Authenticates a device using the provided credentials.

Method And Url

POST https://api.losant.com/auth/device

Authentication

No authentication is required for this endpoint.

Request Body

The body of the request should be serialized JSON that validates against the Device Credentials schema. For example, the following would be a valid body for this request:

{
  "deviceId": "575ecf887ae143cd83dc4aa2",
  "key": "this_would_be_the_key",
  "secret": "this_would_be_the_secret"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -X POST \
    -d '{"deviceId":"575ecf887ae143cd83dc4aa2","key":"this_would_be_the_key","secret":"this_would_be_the_secret"}' \
    https://api.losant.com/auth/device

Successful Responses

Code	Type	Description
200	Authenticated Device	Successful authentication. The included api access token by default has the scope 'all.Device'.

Error Responses

Code	Type	Description
400	Error	Error if malformed request
401	Error	Unauthorized error if authentication fails

Authenticate User

Authenticates a user using the provided credentials.

Method And Url

POST https://api.losant.com/auth/user

Authentication

No authentication is required for this endpoint.

Request Body

The body of the request should be serialized JSON that validates against the User Credentials schema. For example, the following would be a valid body for this request:

{
  "email": "email@example.com",
  "password": "this is the password"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -X POST \
    -d '{"email":"email@example.com","password":"this is the password"}' \
    https://api.losant.com/auth/user

Successful Responses

Code	Type	Description
200	Authenticated User	Successful authentication. The included api access token has the scope 'all.User'.

Error Responses

Code	Type	Description
400	Error	Error if malformed request
401	Error	Unauthorized error if authentication fails

Authenticate User Github

Authenticates a user via GitHub OAuth.

Method And Url

POST https://api.losant.com/auth/user/github

Authentication

No authentication is required for this endpoint.

Request Body

The body of the request should be serialized JSON that validates against the Github Login schema. For example, the following would be a valid body for this request:

{
  "accessToken": "the github access token"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -X POST \
    -d '{"accessToken":"the github access token"}' \
    https://api.losant.com/auth/user/github

Successful Responses

Code	Type	Description
200	Authenticated User	Successful authentication. The included api access token has the scope 'all.User'.

Error Responses

Code	Type	Description
400	Error	Error if malformed request
401	Error	Unauthorized error if authentication fails

Authenticate User Saml

Authenticates a user via a SAML response.

Method And Url

POST https://api.losant.com/auth/user/saml

Authentication

No authentication is required for this endpoint.

Request Body

The body of the request should be serialized JSON that validates against the SAML Response schema. For example, the following would be a valid body for this request:

{
  "SAMLResponse": "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoy...",
  "SAMLDomain": "example.com"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -X POST \
    -d '{"SAMLResponse":"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoy...","SAMLDomain":"example.com"}' \
    https://api.losant.com/auth/user/saml

Successful Responses

Code	Type	Description
200	Authenticated User	Successful authentication. The included api access token has the scope 'all.User'.

Error Responses

Code	Type	Description
400	Error	Error if malformed request
401	Error	Unauthorized error if authentication fails

Sso Domain

Checks email domain for SSO configuration.

Method And Url

GET https://api.losant.com/auth/ssoDomain

Authentication

No authentication is required for this endpoint.

Request Query Parameters

Name	Required	Description	Default	Example
email	Y	The email address associated with the user login		`email=example@example.com`

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -X GET \
    https://api.losant.com/auth/ssoDomain?email=example%40example.com

Successful Responses

Code	Type	Description
200	SSO Request	Successful finding SSO for domain. Returns SSO request URL and type.
204	undefined	No domain associated with an SSO configuration

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Schemas

Authenticated Device

Schema for the successful response when authenticating a Device

Authenticated Device Schema

▶
root:{} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys▶
applicationId:{} 2 keys
▶
deviceId:{} 2 keys
▶
deviceClass:{} 2 keys
▶
token:{} 2 keys
▶
ownerType:{} 2 keys
▶
filterType:{} 1 key
▶
pubTopics:{} 2 keys
▶
subTopics:{} 2 keys
▶
required:[] 4 items

Authenticated Device Example

▶
root:{} 8 keysapplicationId:"575ec8687ae143cd83dc4a97"
deviceId:"575ecf887ae143cd83dc4aa2"
deviceClass:"standalone"
token:"token_to_use_for_authenticating_subsequent_requests"
ownerType:"organization"
filterType:"whitelist"
▶
pubTopics:[] 1 item
▶
subTopics:[] 1 item

Authenticated User

Schema for the successful response when authenticating a User

Authenticated User Schema

▶
root:{} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys▶
userId:{} 2 keys
▶
token:{} 2 keys
▶
needsToVerifyEmail:{} 1 key
▶
orgId:{} 2 keys
▶
required:[] 2 items

Authenticated User Example

▶
root:{} 2 keysuserId:"575ed70c7ae143cd83dc4aa9"
token:"token_to_use_for_authenticating_subsequent_requests"

Device Credentials

Schema for the body of a device authentication request

Device Credentials Schema

▶
root:{} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys▶
deviceId:{} 2 keys
▶
key:{} 1 key
▶
secret:{} 1 key
▶
tokenTTL:{} 2 keys
▶
requestedScopes:{} 3 keys
▶
required:[] 1 item
additionalProperties:false

Device Credentials Example

▶
root:{} 3 keysdeviceId:"575ecf887ae143cd83dc4aa2"
key:"this_would_be_the_key"
secret:"this_would_be_the_secret"

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keystype:"NotFound"
message:"Application was not found"

Schema for the body of a Github login request

▶
root:{} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
accessToken:{} 3 keys
▶
requestedScopes:{} 3 keys
▶
tokenTTL:{} 2 keys
▶
required:[] 1 item
additionalProperties:false

▶
root:{} 1 keyaccessToken:"the github access token"

SAML Response

SAML Response body for login

SAML Response Schema

▶
root:{} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys▶
SAMLResponse:{} 3 keys
▶
SAMLDomain:{} 3 keys
▶
requestedScopes:{} 3 keys
▶
tokenTTL:{} 2 keys
▶
required:[] 2 items
additionalProperties:false

SAML Response Example

▶
root:{} 2 keysSAMLResponse:"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoy..."
SAMLDomain:"example.com"

SSO Request

SSO Request built from the SP and IDP config

SSO Request Schema

▶
root:{} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
ssoType:{} 2 keys
▶
ssoRequest:{} 2 keys
▶
required:[] 2 items

SSO Request Example

▶
root:{} 2 keysssoType:"SAML"
ssoRequest:"http://localhost:8080/simplesaml/saml2/idp/SSOService.php?SAMLRequest=fZJdT8MgFIb%2..."

User Credentials

Schema for the body of a User authentication request

User Credentials Schema

▶
root:{} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys▶
email:{} 3 keys
▶
password:{} 3 keys
▶
twoFactorCode:{} 2 keys
▶
requestedScopes:{} 3 keys
▶
tokenTTL:{} 2 keys
▶
required:[] 2 items
additionalProperties:false

User Credentials Example

▶
root:{} 2 keysemail:"email@example.com"
password:"this is the password"

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.

Authenticate Device​

Method And Url​

Authentication​

Request Body​

Curl Example​

Successful Responses​

Error Responses​

Authenticate User​

Method And Url​

Authentication​

Request Body​

Curl Example​

Successful Responses​

Error Responses​

Authenticate User Github​

Method And Url​

Authentication​

Request Body​

Curl Example​

Successful Responses​

Error Responses​

Authenticate User Saml​

Method And Url​

Authentication​

Request Body​

Curl Example​

Successful Responses​

Error Responses​

Sso Domain​

Method And Url​

Authentication​

Request Query Parameters​

Curl Example​

Successful Responses​

Error Responses​

Schemas​

Authenticated Device​

Authenticated Device Schema​

Authenticated Device Example​

Authenticated User​

Authenticated User Schema​

Authenticated User Example​

Device Credentials​

Device Credentials Schema​

Device Credentials Example​

Error​

Error Schema​

Error Example​

Github Login​

Github Login Schema​

Github Login Example​

SAML Response​

SAML Response Schema​

SAML Response Example​

SSO Request​

SSO Request Schema​

SSO Request Example​

User Credentials​

User Credentials Schema​

User Credentials Example​

Was this page helpful?

Authenticate Device

Method And Url

Authentication

Request Body

Curl Example

Successful Responses

Error Responses

Authenticate User

Method And Url

Authentication

Request Body

Curl Example

Successful Responses

Error Responses

Authenticate User Github

Method And Url

Authentication

Request Body

Curl Example

Successful Responses

Error Responses

Authenticate User Saml

Method And Url

Authentication

Request Body

Curl Example

Successful Responses

Error Responses

Sso Domain

Method And Url

Authentication

Request Query Parameters

Curl Example

Successful Responses

Error Responses

Schemas

Authenticated Device

Authenticated Device Schema

Authenticated Device Example

Authenticated User

Authenticated User Schema

Authenticated User Example

Device Credentials

Device Credentials Schema

Device Credentials Example

Error

Error Schema

Error Example

Github Login

Github Login Schema

Github Login Example

SAML Response

SAML Response Schema

SAML Response Example

SSO Request

SSO Request Schema

SSO Request Example

User Credentials

User Credentials Schema

User Credentials Example