AUTH.SIGNIN

POST 

To signin and return a JWT for the session. User can signin with password, otp and invite

Request

application/json

Body

oneOf
SIGNIN_WITH_EMAIL_AND_PASSWORD
action stringrequired
Default value: auth.signin
The action
grant_type required
Possible values: [password]
The method of which to signin
email stringrequired
The email
password stringrequired
The password
aud string
SIGNIN_WITH_EMAIL_PASSWORD_AND_OTP
action stringrequired
Default value: auth.signin
The action
grant_type required
Possible values: [password]
The method of which to signin
email stringrequired
The email
password stringrequired
The password
otp stringrequired
OTP that was sent to the user, with the intent 'signin'
aud string
The aud
SIGNIN_WITH_EMAIL_AND_OTP
action stringrequired
Default value: auth.signin
The action
grant_type required
Possible values: [otp]
The method of which to signin
email stringrequired
The email
otp stringrequired
The OTP code sent to user with intent: 'signin'
SIGNIN_WITH_INVITE_EMAIL_AND_OTP
action stringrequired
Default value: auth.signin
The action
grant_type required
Possible values: [otp]
The method of which to signin
email stringrequired
The email
otp stringrequired
The OTP code sent to user with intent: 'invite'
password stringrequired
The password
display_name string
phone_number string

Responses

200

Auth JWT Token response

application/json

Schema

Schema

data object

id_token string

The JWT ID Token

refresh_token string

The refresh token to be kept private

token_type string

The token type, set to be bearer

token_info object

Token info

ttl integer

The JWT time to live (ttl) from the issued at time (iat)

exp integer

The JWT expire time

iat integer

The JWT issued at time

aud string

The audience

_userkey string

The user key

project_id string

The Project ID

user_profile object

The user profile

_userkey string

The user's Key

email string

The user's email

email_verified boolean

Boolean indicating email is verified

display_name string

The full display name

photo_url string

The photo URL

username string

The username

aud string

The 'aud' associated to this authentication

roles string[]

Array of roles for this authentication

auth_types string[]

Array of auth_types for this authentication

Example (from schema)

{
  "data": {
    "id_token": "string",
    "refresh_token": "string",
    "token_type": "string",
    "token_info": {
      "ttl": 0,
      "exp": 0,
      "iat": 0,
      "aud": "string",
      "_userkey": "string",
      "project_id": "string"
    },
    "user_profile": {
      "_userkey": "string",
      "email": "string",
      "email_verified": true,
      "display_name": "string",
      "photo_url": "string",
      "username": "string",
      "aud": "string",
      "roles": [
        "string"
      ],
      "auth_types": [
        "string"
      ]
    }
  }
}

Loading...