Authentication

Authentication with email and password

POSThttps://api.pingstreams.com/v3/auth/signin

Allows to authenticate an agent using email and password.

Headers

Name	Type	Description
Content-Type	string	use “application/json” value

Request Body

Name	Type	Description
email	string	the user email address
password	string	the user password

Response

{
  "success": true,
  "token": "JWT XYZ",
  "user": {
    "_id": "5ab11c6b83dc240014d46095",
    "email": "user@example.com"
  }
}

Anonymous authentication for a user

POSThttps://api.pingstreams.com/v3/auth/signinAnonymously

Allows a user to authenticate anonymously on the system.

Headers

Name	Type	Description
Content-Type	string	use “application/json” value

Request Body

Name	Type	Description
id_project	string	the project to which the user belongs
firstname	string	the user firstname
lastname	string	the user lastname
email	string	the user email
attributes	object	the user custom attributes

Response

{
  "success": true,
  "token": "JWT XYZ",
  "user": {
    "_id": "5e25944ecf6bcc00178e75fa",
    "email": "user@example.com",
    "emailverified": false,
    "createdAt": "2020-01-20T11:51:42.115Z",
    "updatedAt": "2020-01-20T11:51:42.115Z",
    "__v": 0
  }
}

Custom authentication for a user

POSThttps://api.pingstreams.com/v3/auth/signinWithCustomToken

Allows to authenticate with a custom JWT token.

Headers

Name	Type	Description
Authorization	string	Custom JWT Authorization token.

Response

{
  "success": true,
  "token": "JWT eyJ0eXYZ",
  "user": {
    "_id": "123456",
    "firstname": "Andrea",
    "lastname": "Leo",
    "email": "user@example.com",
    "code": "123456",
    "sub": "userexternal",
    "aud": "https://pingstreams.com/projects/5ec688ed13400f0012c2edd1",
    "iat": 1598865103,
    "exp": 1598865223
  }
}

Example

curl 'https://api.pingstreams.com/v3/auth/signinWithCustomToken' \
  -X 'POST' \
  -H 'authorization: JWT eyJ0eXAiOiJKVXYZZ....ZZZZZ'

You can find here How to Generate a Custom Authentication Token